➜

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.

classification
Title: Confusing presentation for configuration settings references
Type: enhancement Stage:
Components: Documentation Versions: Python 3.8
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: MegMM, docs@python
Priority: normal Keywords:

Created on 2020-09-05 18:32 by MegMM, last changed 2022-04-11 14:59 by admin.

Files
File name Uploaded Description Edit
SUGGESTED CHANGE-- venv.html MegMM, 2020-09-05 18:32 Brief HTML view of preferred presentation
Messages (1)
msg376436 - (view) Author: MegMM (MegMM) * Date: 2020-09-05 18:32 
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
2022-04-11 14:59:35adminsetgithub: 85893
2020-09-05 18:32:28MegMMcreate