docs(clean): add documentation for clean_address

Add user guide for clean_address() and validate_address() functions. Closes #481
sfu-db · Feb 23, 2021 · 4061fca · 4061fca
1 parent 5878dc0
commit 4061fca
Show file tree

Hide file tree

Showing 3 changed files with 3,593 additions and 3 deletions.
diff --git a/dataprep/clean/clean_address.py b/dataprep/clean/clean_address.py
@@ -40,6 +40,8 @@ def clean_address(
     """
     Clean and standardize US street addresses.
 
+    Read more in the :ref:`User Guide <address_userguide>`.
+
     Parameters
     ----------
     df
@@ -172,6 +174,8 @@ def validate_address(
     """
     Validate US street addresses.
 
+    Read more in the :ref:`User Guide <address_userguide>`.
+
     Parameters
     ----------
     x