Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-42236: Enhance init and encoding documentation #23109

Merged
merged 1 commit into from
Nov 2, 2020
Merged

bpo-42236: Enhance init and encoding documentation #23109

merged 1 commit into from
Nov 2, 2020

Conversation

vstinner
Copy link
Member

@vstinner vstinner commented Nov 2, 2020

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.

https://bugs.python.org/issue42236

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.
@vstinner vstinner merged commit 4b9aad4 into python:master Nov 2, 2020
@vstinner vstinner deleted the init_doc branch November 2, 2020 15:49
adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 13, 2021
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants