]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
bpo-42236: Enhance init and encoding documentation (GH-23109)
authorVictor Stinner <vstinner@python.org>
Mon, 2 Nov 2020 15:49:54 +0000 (16:49 +0100)
committerGitHub <noreply@github.com>
Mon, 2 Nov 2020 15:49:54 +0000 (16:49 +0100)
commit4b9aad49992a825d8c76e428ed1aca81dd3878b2
tree3834f555ab9a469313ba1783b1e2e5ca7af94e51
parent301822859b3fc34801a06f1090d62f9f2ee5b092
bpo-42236: Enhance init and encoding documentation (GH-23109)

Enhance the documentation of the Python startup, filesystem encoding
and error handling, locale encoding. Add a new "Python UTF-8 Mode"
section.

* Add "locale encoding" and "filesystem encoding and error handler"
  to the glossary
* Remove documentation from Include/cpython/initconfig.h: move it to
  Doc/c-api/init_config.rst.
* Doc/c-api/init_config.rst:

  * Document command line options and environment variables
  * Document default values.

* Add a new "Python UTF-8 Mode" section in Doc/library/os.rst.
* Add warnings to Py_DecodeLocale() and Py_EncodeLocale() docs.
* Document how Python selects the filesystem encoding and error
  handler at a single place: PyConfig.filesystem_encoding and
  PyConfig.filesystem_errors.
* PyConfig: move orig_argv member at the right place.
19 files changed:
Doc/c-api/exceptions.rst
Doc/c-api/init.rst
Doc/c-api/init_config.rst
Doc/c-api/sys.rst
Doc/c-api/unicode.rst
Doc/c-api/veryhigh.rst
Doc/glossary.rst
Doc/howto/unicode.rst
Doc/library/devmode.rst
Doc/library/exceptions.rst
Doc/library/locale.rst
Doc/library/os.rst
Doc/library/sys.rst
Doc/using/cmdline.rst
Doc/using/windows.rst
Doc/whatsnew/3.7.rst
Include/cpython/initconfig.h
Python/initconfig.c
Python/preconfig.c