summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBernát Gábor <gaborjbernat@gmail.com>2018-10-13 16:09:14 +0100
committerGitHub <noreply@github.com>2018-10-13 16:09:14 +0100
commit8de2cefa6f0e6853dcdf2f0db9f683240d70aa82 (patch)
treeb0ecb8743aa7fd0a7f881729293de15753f16fa7
parentefc08786de5716f93d96412e98c429197c8ab41b (diff)
downloadtox-git-8de2cefa6f0e6853dcdf2f0db9f683240d70aa82.tar.gz
document substituions additional content start with space (#1056)
document substitutions with additional content starting with a space cannot be alone on a line inside the ini file
-rw-r--r--docs/changelog/1051.bugfix.rst7
-rw-r--r--docs/changelog/437.doc.rst1
-rw-r--r--docs/config.rst8
3 files changed, 12 insertions, 4 deletions
diff --git a/docs/changelog/1051.bugfix.rst b/docs/changelog/1051.bugfix.rst
index 398f1cbe..ee9f8cdb 100644
--- a/docs/changelog/1051.bugfix.rst
+++ b/docs/changelog/1051.bugfix.rst
@@ -1,4 +1,3 @@
-Do the same transformation to egg_info dirs that pkg_resources does. This makes
-it possible for hyphenated names to use the develop-inst-noop optimization (cf.
-#910), which previously only worked with non-hyphenated egg names - by
-:user:`hashbrowncipher`.
+Do the same transformation to egg_info dirs that pkg_resources does.
+This makes it possible for hyphenated names to use the develop-inst-noop optimization (cf. 910), which previously only worked with non-hyphenated egg names - by
+:user:`hashbrowncipher`
diff --git a/docs/changelog/437.doc.rst b/docs/changelog/437.doc.rst
new file mode 100644
index 00000000..bd9ed08e
--- /dev/null
+++ b/docs/changelog/437.doc.rst
@@ -0,0 +1 @@
+document substitutions with additional content starting with a space cannot be alone on a line inside the ini file - by :user:`gaborbernat`
diff --git a/docs/config.rst b/docs/config.rst
index 72028066..a886dab1 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -499,6 +499,14 @@ You can escape curly braces with the ``\`` character if you need them, for examp
commands = echo "\{posargs\}" = {posargs}
+
+Note some substitutions (e.g. ``posargs``, ``env``) may have addition values attached to it,
+via the ``:`` character (e.g. ``posargs`` - default value, ``env`` - key).
+Such substitutions cannot have a space after the ``:`` character
+(e.g. ``{posargs: magic}`` while being at the start of a line
+inside the ini configuration (this would be parsed as factorial ``{posargs``,
+having value magic).
+
Globally available substitutions
++++++++++++++++++++++++++++++++