Skip to content

Commit

Permalink
Merge pull request #2113 from moj-analytical-services/spellchecker_fix
Browse files Browse the repository at this point in the history
Minor fixes to spellchecker
  • Loading branch information
zslade committed Mar 28, 2024
2 parents ae85c13 + 28af8cb commit 5d7ea7c
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/demos/examples/examples_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:

# Example Notebooks

This section provides a series of examples to help you get started with Splink. You can find the underlying notebooks in the [demos folder](https://github.com/moj-analytical-services/splink/tree/master/docs/demos/examples) of the Splink repo.
This section provides a series of examples to help you get started with Splink. You can find the underlying notebooks in the [demos folder](https://github.com/moj-analytical-services/splink/tree/master/docs/demos/examples) of the Splink repository.

You can try these demos live in your web browser using the following link:

Expand Down
2 changes: 1 addition & 1 deletion docs/dev_guides/changing_splink/contributing_to_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ 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_.
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.

To run the spellchecker on either a single markdown file or folder of markdown files, you can use the following script:

Expand Down
1 change: 1 addition & 0 deletions scripts/pyspelling/custom_dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ HU
Harpenden
Harron
Hepworth
Homebrew
JL
Jaccard
Jaro
Expand Down

0 comments on commit 5d7ea7c

Please sign in to comment.