This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author MegMM
Recipients MegMM, docs@python
Date 2020-09-05.18:32:27
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1599330748.16.0.0755344279451.issue41727@roundup.psfhosted.org>
In-reply-to
Content
Priority: LOW
Keywords: Documentation, Presentation of configuration settings

Most of the documentation is excellent, but I'm running into a confusing method of referring to configuration settings in files. For instance on https://docs.python.org/3/library/venv.html, there is a section that reads:

The created pyvenv.cfg file also includes the include-system-site-packages key, set to true if venv is run with the --system-site-packages option, false otherwise.


Nothing about it is wrong but the presentation of the setting and variable should written as shown in the file instead of written out: "include-system-site-packages=True" 

Also, I see this in a lot of the documentation, which makes it hard to check if file settings match up with documentation as expected or not.
History
Date User Action Args
2020-09-05 18:32:28MegMMsetrecipients: + MegMM, docs@python
2020-09-05 18:32:28MegMMsetmessageid: <1599330748.16.0.0755344279451.issue41727@roundup.psfhosted.org>
2020-09-05 18:32:28MegMMlinkissue41727 messages
2020-09-05 18:32:27MegMMcreate