fix docs, closes #1203

dedupeio · Aug 10, 2024 · 3d5d3ad · 3d5d3ad
1 parent a75bb54
commit 3d5d3ad
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 14 deletions.
diff --git a/docs/API-documentation.rst b/docs/API-documentation.rst
@@ -10,10 +10,10 @@ Library Documentation
 
         # initialize from a defined set of fields
         variables = [
-            {'field' : 'Site name', 'type': 'String'},
-            {'field' : 'Address', 'type': 'String'},
-            {'field' : 'Zip', 'type': 'String', 'has missing':True},
-            {'field' : 'Phone', 'type': 'String', 'has missing':True},
+	    dedupe.variables.String("Site name"),
+	    dedupe.variables.String("Address"),
+	    dedupe.variables.String("Zip", has_missing=True),
+	    dedupe.variables.String("Phone", has_missing=True),
         ]
         deduper = dedupe.Dedupe(variables)
 
@@ -48,10 +48,10 @@ Library Documentation
 
         # initialize from a defined set of fields
         variables = [
-            {'field' : 'Site name', 'type': 'String'},
-            {'field' : 'Address', 'type': 'String'},
-            {'field' : 'Zip', 'type': 'String', 'has missing':True},
-            {'field' : 'Phone', 'type': 'String', 'has missing':True},
+	    dedupe.variables.String("Site name"),
+	    dedupe.variables.String("Address"),
+	    dedupe.variables.String("Zip", has_missing=True),
+	    dedupe.variables.String("Phone", has_missing=True),
         ]
         deduper = dedupe.RecordLink(variables)
 
@@ -85,10 +85,10 @@ Library Documentation
 
         # initialize from a defined set of fields
         variables = [
-            {'field' : 'Site name', 'type': 'String'},
-            {'field' : 'Address', 'type': 'String'},
-            {'field' : 'Zip', 'type': 'String', 'has missing':True},
-            {'field' : 'Phone', 'type': 'String', 'has missing':True},
+	    dedupe.variables.String("Site name"),
+	    dedupe.variables.String("Address"),
+	    dedupe.variables.String("Zip", has_missing=True),
+	    dedupe.variables.String("Phone", has_missing=True),
         ]
         matcher = dedupe.Gazetteer(variables)
 

diff --git a/docs/Variable-definition.rst b/docs/Variable-definition.rst
@@ -6,8 +6,8 @@ Variable Definitions
 Variables
 ---------
 
-A variable definition describes the records that you want to match. It is sequence
-of Variable objects. For example:-
+A variable definition describes the records that you want to match. It
+is a collection of Variable objects. For example:-
 
 .. code:: python