update(docguides): add rst-format rules description

Signed-off-by: Daniel Oliveira <[email protected]>
bao-project · Dec 6, 2023 · 1af4773 · 1af4773
1 parent 5dfb2fe
commit 1af4773
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/source/development/doc_guidelines.rst b/source/development/doc_guidelines.rst
@@ -460,6 +460,16 @@ To run the `doc8 <https://github.com/PyCQA/doc8>`_ format checker:
 
     make rst-format
 
+Besides checking for invalid reST format styles (D000 rule), the ``rst-format`` also checks
+for:
+
+.. note::
+    - lines longer than 99 characters - D001
+    - no trailing whitespace - D002
+    - no tabulation for indentation - D003
+    - no carriage returns (use unix newlines) - D004
+    - no newline at end of file - D005
+
 **Spelling Dictionaries**
 
 The spell checker uses standard enchant dictionaries to validate words. However, some specific

diff --git a/source/spelling_wordlist.txt b/source/spelling_wordlist.txt
@@ -66,3 +66,4 @@ Submodules
 subdirectory
 scalability
 codebase
+unix