Update docs and version bump

Includes updating the blocking tutorial.
data61 · Mar 10, 2021 · 6a1f0ee · 6a1f0ee
1 parent 6168e77
commit 6a1f0ee
Show file tree

Hide file tree

Showing 6 changed files with 263 additions and 311 deletions.
diff --git a/docs/blocking-schema.rst b/docs/blocking-schema.rst
@@ -40,7 +40,7 @@ Example Schema
       "type": "lambda-fold",
       "version": 1,
       "config": {
-        "blocking-features": [1, 2],
+        "blocking-features": ["name", "suburb"],
         "Lambda": 30,
         "bf-len": 2048,
         "num-hash-funcs": 5,

diff --git a/docs/development.rst b/docs/development.rst
@@ -4,25 +4,22 @@ Development
 Testing
 -------
 
-Make sure you have all the required modules before running the tests
-(modules that are only needed for tests are not included during
-installation)::
+Make sure you have all the required dependencies before running the tests::
 
 
-    $ pip install -r requirements.txt
+    $ poetry install
 
 
-Now run the unit tests and print out code coverage with `py.test`::
+Now run the unit tests and print out code coverage with `pytest`::
 
-    $ python -m pytest --cov=blocklib
+    $ poetry run pytest --cov=blocklib
 
 
 Type Checking
 -------------
 
 
-``blocklib`` uses static typechecking with ``mypy``. To run the type checker (in Python 3.5 or later)::
+``blocklib`` uses static typechecking with ``mypy``. To run the type checker as configured to run in the CI::
 
-    $ pip install mypy
-    $ mypy blocklib --ignore-missing-imports --strict-optional --no-implicit-optional --disallow-untyped-calls
+    $ poetry run mypy blocklib --ignore-missing-imports --strict-optional --no-implicit-optional --disallow-untyped-calls
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -11,13 +11,14 @@ record linkage scalable. It is achieved by partitioning datasets into groups, ca
 records in corresponding blocks. This can reduce the number of comparisons that need to be conducted to find which
 pairs of records should be linked.
 
-Note that it is part of anonlink system which includes libraries for encoding, command line tools and Rest API:
+Note that it is part of the anonlink system which includes libraries for encoding, command line tools and Rest API:
 
 * `clkhash <https://github.com/data61/clkhash>`_
 * `anonlink-client <https://github.com/data61/anonlink-client>`_
+* `anonlink <https://github.com/data61/anonlink>`_
 * `anonlink-entity-service <https://github.com/data61/anonlink-entity-service>`_
 
-Blocklib is Apache 2.0 licensed, supports Python version 3.5+ and run on Windows, OSX and Linux.
+Blocklib is Apache 2.0 licensed, supports Python version 3.6+ and run on Windows, OSX and Linux.
 
 Install with pip::