diff options
| author | kotfu <kotfu@kotfu.net> | 2019-07-06 13:53:45 -0600 |
|---|---|---|
| committer | kotfu <kotfu@kotfu.net> | 2019-07-06 13:53:45 -0600 |
| commit | 9fe8e36a1e26569bdb47b8c361d077675a876af9 (patch) | |
| tree | 8e72372456ab4f50b61df443fdc1504afb6c1268 /docs/features/scripting.rst | |
| parent | 6a5b9f8e13c9aed75ea23a23bad8ea0c64e90ff7 (diff) | |
| download | cmd2-git-9fe8e36a1e26569bdb47b8c361d077675a876af9.tar.gz | |
Add doc8 documentation style checking
- add dev dependency
- add doc8 to tasks.py
- fix all doc8 errors
Diffstat (limited to 'docs/features/scripting.rst')
| -rw-r--r-- | docs/features/scripting.rst | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/features/scripting.rst b/docs/features/scripting.rst index c6869774..73566cde 100644 --- a/docs/features/scripting.rst +++ b/docs/features/scripting.rst @@ -6,13 +6,15 @@ Document use cases and commands for ``run_script`` and ``run_pyscript`` Comments -------- -Any command line input where the first non-whitespace character is a `#` will be treated as a comment. -This means any `#` character appearing later in the command will be treated as a literal. The same -applies to a `#` in the middle of a multiline command, even if it is the first character on a line. +Any command line input where the first non-whitespace character is a `#` will +be treated as a comment. This means any `#` character appearing later in the +command will be treated as a literal. The same applies to a `#` in the middle +of a multiline command, even if it is the first character on a line. -Comments can be useful in :ref:`scripts`, but would be pointless within an interactive session. +Comments can be useful in :ref:`scripts`, but would be pointless within an +interactive session. :: (Cmd) # this is a comment - (Cmd) this # is not a comment
\ No newline at end of file + (Cmd) this # is not a comment |