(WIP) Feature/postgres similarity functions

.gitignore

@@ -179,3 +179,5 @@ cython_debug/
 splink_db
 splink_db_log
 spark-warehouse
+
+scripts/pyspelling/dictionary.dic

README.md

@@ -7,7 +7,7 @@
 [![Documentation](https://img.shields.io/badge/API-documentation-blue)](https://moj-analytical-services.github.io/splink/)
 
 > [!IMPORTANT]
-> Development has begun on Splink 4 on the `splink4_dev` branch.  Splink 3 is in maintenance mode and we are no longer accepting new features. We welcome contributions to Splink 4. Read more on our latest [blog](https://moj-analytical-services.github.io/splink/blog/2024/03/19/splink4.html).
+> Development has begun on Splink 4 on the `splink4_dev` branch.  Splink 3 is in maintenance mode and we are no longer accepting new features. We welcome contributions to Splink 4. Read more on our latest [blog](https://moj-analytical-services.github.io/splink/blog/2024/04/02/splink-3-updates-and-splink-4-development-announcement---april-2024.html).
 
 # Fast, accurate and scalable probabilistic data linkage
 

docs/dev_guides/changing_splink/contributing_to_docs.md

@@ -16,29 +16,35 @@ Once you've finished updating Splink documentation we ask that you run our spell
 
 ## Spellchecking docs
 
-When updating Splink documentation, we ask that you run our spellchecker before submitting a pull request. This is to help ensure quality and consistency across the documentation. Please note, the spellchecker _only works on markdown files_ and currently only works on systems which support `Homebrew` package manager. Instructions for other operating systems will be released later.
+When updating Splink documentation, we ask that you run our spellchecker before submitting a pull request. This is to help ensure quality and consistency across the documentation. If for whatever reason you can't run the spellchecker on your system, please don't let this prevent you from contributing to the documentation. Please note, the spellchecker _only works on markdown files_.
 
-To run the spellchecker on either a single markdown file or folder of markdown files, you can use the following script:
+If you are a Mac user with the `Homebrew` package manager installed, the script below will automatically install
+the required system dependency, `aspell`.
+If you've created your development environment [using conda](./development_quickstart.md), `aspell` will have been installed as part of that
+process.
+Instructions for installing `aspell` through other means may be added here in the future.
+
+To run the spellchecker on either a single markdown file or folder of markdown files, you can run the following bash script:
 
 ```sh
-source scripts/pyspelling/spellchecker.sh <path_to_file_or_folder>
+./scripts/pyspelling/spellchecker.sh <path_to_file_or_folder>
 ```
 
 Omitting the file/folder path will run the spellchecker on all markdown files contained in the `docs` folder. We recommend running the spellchecker only on files that you have created or edited. 
 
 The spellchecker uses the Python package [PySpelling](https://facelessuser.github.io/pyspelling/) and its underlying spellchecking tool, Aspell. Running the above script will automatically install these packages along with any other necessary dependencies.
 
-The spellchecker compares words to a [standard British English dictionary](https://github.com/LibreOffice/dictionaries/blob/master/en/en_GB.aff) and a custom dictionary (`scripts/pyspelling/custom_dictionary.txt`) of words. If no spelling mistakes are found, you will see the following terminal printout:
+The spellchecker compares words to a standard British English dictionary and a custom dictionary (`scripts/pyspelling/custom_dictionary.txt`) of words. If no spelling mistakes are found, you will see the following terminal printout:
 
-```sh
+```
 
 Spelling check passed :)
 
 ```
 
 otherwise, PySpelling will printout the spelling mistakes found in each file.
 
-Correct spellings of words not found in a standard dictionary (e.g. Splink) can be recorded as such by adding them to `scripts/pyspelling/custom_dictionary.txt`. (Don't worry about adding them in alphabetical order or accidental duplication as this will be handled automatically by a GitHub Action future.)
+Correct spellings of words not found in a standard dictionary (e.g. "Splink") can be recorded as such by adding them to `scripts/pyspelling/custom_dictionary.txt`.
 
 Please correct any mistakes found or update the custom dictionary to ensure the spellchecker passes before putting in a pull request containing updates to the documentation.
 

docs/dev_guides/changing_splink/development_quickstart.md

@@ -114,7 +114,7 @@ and the teardown script each time you want to stop it:
 ```
 
 Included in the docker-compose file is a [pgAdmin](https://www.pgadmin.org/) container to allow easy exploration of the database as you work, which can be accessed in-browser on the default port.
-The default username is `[email protected]` with password `b`.
+The default url: http://localhost:80/ username is `[email protected]` with password `b`.
 
 ## Step 3, Conda install option: Install system dependencies