diff options
author | kotfu <kotfu@kotfu.net> | 2019-07-02 19:34:37 -0600 |
---|---|---|
committer | kotfu <kotfu@kotfu.net> | 2019-07-02 19:34:37 -0600 |
commit | 11da5ba65a43c63364e702de726a7bf09a1241b4 (patch) | |
tree | 03f0b4ba0f484bc516d6db617cdce6e4c4512dcd /docs/features/scripting.rst | |
parent | 92ae130c38520b249eb7351cfb0da1ad67d3d3cf (diff) | |
download | cmd2-git-11da5ba65a43c63364e702de726a7bf09a1241b4.tar.gz |
Skeleton doc structure complete for #709
Diffstat (limited to 'docs/features/scripting.rst')
-rw-r--r-- | docs/features/scripting.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/features/scripting.rst b/docs/features/scripting.rst new file mode 100644 index 00000000..c6869774 --- /dev/null +++ b/docs/features/scripting.rst @@ -0,0 +1,18 @@ +Scripting +========= + +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. + +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 |