diff options
| author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2019-03-02 12:14:32 -0500 |
|---|---|---|
| committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2019-03-02 12:14:32 -0500 |
| commit | 1a2465ad84962a321aa6f4d59a3fdf4f2574273f (patch) | |
| tree | 2cf3dcf6bd36eb36331f239faa5b3327878a4a84 | |
| parent | 5b92db1aadfa7fd0b746d3516bf7e7a13a0cdc91 (diff) | |
| download | cmd2-git-1a2465ad84962a321aa6f4d59a3fdf4f2574273f.tar.gz | |
Updated docs
| -rw-r--r-- | CHANGELOG.md | 4 | ||||
| -rw-r--r-- | docs/freefeatures.rst | 3 |
2 files changed, 6 insertions, 1 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 3cc43917..71fb35ec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,7 +13,9 @@ of only supporting one ``pyscript`` interface. This simplifies future maintenance. * No longer supporting C-style comments. Hash (#) is the only valid comment marker. * No longer supporting comments embedded in a command. Only command line input where the first - non-whitespace character is a # will be treated as a comment. + 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. * \# this is a comment * this # is not a comment 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. :: |