Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for spell check #83

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add documentation for spell check #83

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ebe216f
Add documentation for spelling check
mahadevkanishk Apr 12, 2021
b97e902
Improve documentation
mahadevkanishk Apr 12, 2021
963fdc3
Update docs-developer-guide.rst
mahadevkanishk Apr 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion odkx-src/docs-developer-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,6 +341,18 @@ specify the check name in the check list
in the function :py:func:`exclude_checks`
in the file :file:`style-test.py`.

Excluding Spelling checks
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalization is uneven here. Also a bit confusing "Excluding spelling checks." Maybe instead "Excluding specific words from the spelling check" or something similar. You aren't canceling the whole check.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To exclude a word from spelling check,specify the word under the title spelling on the top of the document.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing a space between check, and specify. Also should be a "the" before spelling check. "At" not "on" the top of the document.

Example:

.. code-block:: console

.. spelling::
phpLDAPadmin
readonly
letsencrypt



Expand All @@ -355,4 +367,4 @@ in the file :file:`style-test.py`.
please update the :file:`requirements.txt` file with
:command:`pip freeze > requirements.txt`.
Pull requests which change :file:`requirements.txt`
should include a note about why the new package is needed.
should include a note about why the new package is needed.