From 1af4773a2c50db4573de14f1055153683e4ea1dd Mon Sep 17 00:00:00 2001 From: Daniel Oliveira Date: Wed, 6 Dec 2023 13:12:49 +0000 Subject: [PATCH] update(docguides): add rst-format rules description Signed-off-by: Daniel Oliveira --- source/development/doc_guidelines.rst | 10 ++++++++++ source/spelling_wordlist.txt | 1 + 2 files changed, 11 insertions(+) diff --git a/source/development/doc_guidelines.rst b/source/development/doc_guidelines.rst index d6c6d6c..85cea82 100644 --- a/source/development/doc_guidelines.rst +++ b/source/development/doc_guidelines.rst @@ -460,6 +460,16 @@ To run the `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 index ce8a205..c383579 100644 --- a/source/spelling_wordlist.txt +++ b/source/spelling_wordlist.txt @@ -66,3 +66,4 @@ Submodules subdirectory scalability codebase +unix