summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKevin Van Brunt <kmvanbrunt@gmail.com>2019-03-02 12:14:32 -0500
committerKevin Van Brunt <kmvanbrunt@gmail.com>2019-03-02 12:14:32 -0500
commit1a2465ad84962a321aa6f4d59a3fdf4f2574273f (patch)
tree2cf3dcf6bd36eb36331f239faa5b3327878a4a84 /docs
parent5b92db1aadfa7fd0b746d3516bf7e7a13a0cdc91 (diff)
downloadcmd2-git-1a2465ad84962a321aa6f4d59a3fdf4f2574273f.tar.gz
Updated docs
Diffstat (limited to 'docs')
-rw-r--r--docs/freefeatures.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/freefeatures.rst b/docs/freefeatures.rst
index c6463d8f..9e8c2cbf 100644
--- a/docs/freefeatures.rst
+++ b/docs/freefeatures.rst
@@ -30,6 +30,9 @@ 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.
::