From b1f8eca6a545fb0e15608f84fcc089a0cb4431ab Mon Sep 17 00:00:00 2001
From: Dan Braghis <dan.braghis@torchbox.com>
Date: Thu, 8 Mar 2018 13:08:46 +0000
Subject: [PATCH] Make note of addressfield storage

---
 addressfield/fields.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/addressfield/fields.py b/addressfield/fields.py
index 0f6015279..32c0c725b 100644
--- a/addressfield/fields.py
+++ b/addressfield/fields.py
@@ -28,6 +28,10 @@ def flatten_data(data):
 
 
 class AddressField(forms.CharField):
+    """
+    The field stores the address in a flattened form,
+    so the locality components are on the same level as country or premise
+    """
     widget = AddressWidget
     data = VALIDATION_DATA
 
-- 
GitLab