11Contributing to the Documentation
22=================================
33
4- Continious Integration
4+ Continuous Integration
55----------------------
66
77The documentations are checked on every new commit through Travis-CI, so that common errors are
@@ -60,13 +60,13 @@ What is checked:
6060 - lines should not be longer than 100 characters - D001
6161
6262 - RST exception: line with no whitespace except in the beginning
63- - RST exception: lines with http or https urls
63+ - RST exception: lines with http or https URLs
6464 - RST exception: literal blocks
6565 - RST exception: rst target directives
6666
6767 - no trailing whitespace - D002
6868 - no tabulation for indentation - D003
69- - no carriage returns (use unix newlines) - D004
69+ - no carriage returns (use UNIX newlines) - D004
7070 - no newline at end of file - D005
7171
7272Extra Style Checks
@@ -87,7 +87,7 @@ Extra Style Checks
8787
8888 -, for subsections
8989
90- ^, for subsubsections
90+ ^, for sub-subsections
9191
9292 ", for paragraphs
9393
@@ -128,6 +128,15 @@ Extra Style Checks
128128
1291295. Using ``:ref: `` only when necessary
130130
131- Use ``:ref: `` to create internal links only when needed, i.e. it is referanced somewhere.
132- Do not create referances for all the sections and then only referance some of them, because
133- this created unnecessary referances. This also generates ERROR in ``restructuredtext-lint ``.
131+ Use ``:ref: `` to create internal links only when needed, i.e. it is referenced somewhere.
132+ Do not create references for all the sections and then only reference some of them, because
133+ this created unnecessary references. This also generates ERROR in ``restructuredtext-lint ``.
134+
135+ 6. Spelling
136+
137+ You should check for spelling errors before you push changes. `Aspell <http://aspell.net/ >`_
138+ is a GNU project Command Line tool you can use for this purpose. Download and install Aspell,
139+ then execute ``aspell check <file-name> `` for all the files changed. Be careful about not
140+ changing commands or other stuff as Aspell gives prompts for a lot of them. Also delete the
141+ temporary ``.bak `` files generated. Refer the `manual <http://aspell.net/man-html/ >`_ for more
142+ information on how to use.
0 commit comments