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: [doc] Py_UTF8Mode is not documented
Type: enhancement Stage: patch review
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Mariatta Nosy List: Mariatta, docs@python, ncoghlan, serhiy.storchaka, vidhya, vstinner
Priority: normal Keywords: easy, patch

Created on 2018-05-22 13:49 by serhiy.storchaka, last changed 2022-04-11 14:59 by admin.

Files
File name Uploaded Description Edit
init.html vidhya, 2022-02-18 21:05 c-api/init.html
Pull Requests
URL Status Linked Edit
PR 7143 closed y43ren, 2018-05-27 21:06
PR 31480 open vidhya, 2022-02-21 20:09
Messages (7)
msg317286 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2018-05-22 13:49
Py_UTF8Mode was added to the limited API in 3.7, but it is not documented anywhere.
msg317292 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2018-05-22 14:05
I wasn't sure if I should document it, but after talking with Serhiy on IRC, I now agree that the new variable should be documented.

It should be documented at:
https://docs.python.org/dev/c-api/init.html#global-configuration-variables
msg317294 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2018-05-22 14:35
If there are reasons of including it in the limited API, it should be documented.
msg338920 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2019-03-26 22:58
PR 7143 has been closed. So is there another candidate to write the doc?
msg413511 - (view) Author: Vidhya (vidhya) * Date: 2022-02-18 21:05
[Entry level contributor seeking guidance]The PR on this issue looks closed. I worked on this and attaching the updated html file.

I will open a pull request if this is not yet resolved.
msg413648 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2022-02-21 11:45
> [Entry level contributor seeking guidance]The PR on this issue looks closed. I worked on this and attaching the updated html file.

Hi. You should update Doc/c-api/init.rst. Not the generated HTML page.
msg413674 - (view) Author: Vidhya (vidhya) * Date: 2022-02-21 20:15
[Entry level contributor seeking guidance]The rst file is updated in this pull request:
 https://github.com/python/cpython/pull/31480

Unable to update GitHub PR in the issue. Getting the following error "Edit Error: GitHub PR already added to issue"
History
Date User Action Args
2022-04-11 14:59:00adminsetgithub: 77782
2022-02-21 20:15:37vidhyasetmessages: + msg413674
2022-02-21 20:09:18vidhyasetkeywords: + patch
stage: needs patch -> patch review
pull_requests: + pull_request29609
2022-02-21 11:45:54vstinnersetmessages: + msg413648
2022-02-18 21:05:36vidhyasetfiles: + init.html
nosy: + vidhya
messages: + msg413511

2022-01-17 19:08:16iritkatrielsetkeywords: + easy
title: [EASY DOC] Py_UTF8Mode is not documented -> [doc] Py_UTF8Mode is not documented
versions: + Python 3.9, Python 3.10, Python 3.11, - Python 3.7, Python 3.8
2019-04-08 22:47:44cheryl.sabellasetnosy: + Mariatta
assignee: docs@python -> Mariatta
keywords: - patch
type: enhancement
stage: patch review -> needs patch
2019-03-26 22:58:00vstinnersetmessages: + msg338920
2018-07-28 13:04:42steve.dowersetkeywords: - easy
2018-05-27 21:06:34y43rensetkeywords: + patch
stage: patch review
pull_requests: + pull_request6777
2018-05-22 14:35:06serhiy.storchakasetmessages: + msg317294
2018-05-22 14:05:17vstinnersetkeywords: + easy

messages: + msg317292
title: Py_UTF8Mode is not documented -> [EASY DOC] Py_UTF8Mode is not documented
2018-05-22 13:49:41serhiy.storchakacreate