From 3d5d3ad22de1042068140715bcc0bed5736a2008 Mon Sep 17 00:00:00 2001 From: Forest Gregg Date: Fri, 9 Aug 2024 20:00:55 -0400 Subject: [PATCH] fix docs, closes #1203 --- docs/API-documentation.rst | 24 ++++++++++++------------ docs/Variable-definition.rst | 4 ++-- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/API-documentation.rst b/docs/API-documentation.rst index 95bda57f..2e9a4194 100644 --- 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 index 45ca6f7a..644f71bb 100644 --- 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