New submission from MegMM <mm_re...@live.com>:
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. ---------- assignee: docs@python components: Documentation files: SUGGESTED CHANGE-- venv.html messages: 376436 nosy: MegMM, docs@python priority: normal severity: normal status: open title: Confusing presentation for configuration settings references type: enhancement versions: Python 3.8 Added file: https://bugs.python.org/file49446/SUGGESTED CHANGE-- venv.html _______________________________________ Python tracker <rep...@bugs.python.org> <https://bugs.python.org/issue41727> _______________________________________ _______________________________________________ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
