summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CHANGELOG.md4
-rw-r--r--docs/freefeatures.rst3
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.
::