From ebe216f191673c3db8ef7646cab80eebced0995a Mon Sep 17 00:00:00 2001 From: mahadevkanishk <69049257+mahadevkanishk@users.noreply.github.com> Date: Tue, 13 Apr 2021 00:31:54 +0530 Subject: [PATCH 1/3] Add documentation for spelling check --- odkx-src/docs-developer-guide.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/odkx-src/docs-developer-guide.rst b/odkx-src/docs-developer-guide.rst index cf5d8cc2..3a4533d2 100644 --- a/odkx-src/docs-developer-guide.rst +++ b/odkx-src/docs-developer-guide.rst @@ -341,6 +341,19 @@ 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 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To exclude a word from spelling check, +specify the word under the title spelling. +Example: + + .. code-block:: console + + .. spelling:: + phpLDAPadmin + readonly + letsencrypt @@ -355,4 +368,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. \ No newline at end of file + should include a note about why the new package is needed. From b97e902ac34a3a7a2a698c93b814d7fa85f8580a Mon Sep 17 00:00:00 2001 From: mahadevkanishk <69049257+mahadevkanishk@users.noreply.github.com> Date: Tue, 13 Apr 2021 00:33:31 +0530 Subject: [PATCH 2/3] Improve documentation --- odkx-src/docs-developer-guide.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/odkx-src/docs-developer-guide.rst b/odkx-src/docs-developer-guide.rst index 3a4533d2..4d268c52 100644 --- a/odkx-src/docs-developer-guide.rst +++ b/odkx-src/docs-developer-guide.rst @@ -344,8 +344,7 @@ in the file :file:`style-test.py`. Excluding Spelling checks ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -To exclude a word from spelling check, -specify the word under the title spelling. +To exclude a word from spelling check,specify the word under the title spelling on the top of the document. Example: .. code-block:: console From 963fdc3c47c8f9b53ca3cc6e9a0c77fe08c1ccf2 Mon Sep 17 00:00:00 2001 From: mahadevkanishk <69049257+mahadevkanishk@users.noreply.github.com> Date: Tue, 13 Apr 2021 00:35:19 +0530 Subject: [PATCH 3/3] Update docs-developer-guide.rst