Doc update: config.rst bugfixes and formatting

payu-org / payu

A workflow management tool for numerical models on the NCI computing systems

Apache License 2.0

18 stars 25 forks source link

Doc update: config.rst bugfixes and formatting #272

Closed marshallward closed 4 years ago

marshallward commented 4 years ago

This patch fixes some errors in the config.rst documentation file:

A code block was missing its leading blank line
Some double-quote (``) works were using triple-quotes

Some formatting changes were also made:

Trailing whitespace was removed
Column width (79) was consistently appled across the file.

Finally, a typo was fixed (defaul -> default).

coveralls commented 4 years ago

Coverage remained the same at 41.274% when pulling 16efbd0d5afdea8f58cb47c4a8823c792bfe073f on docupdate into e5f3787bf10c753282e9769a6bf44eb4ea96918e on master.

pep8speaks commented 4 years ago

Hello @marshallward! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

In the file docs/source/conf.py:

Line 96:1: E265 block comment should start with '# '

payu-org / payu

Doc update: config.rst bugfixes and formatting #272

Comment last updated at 2020-06-18 03:23:15 UTC