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

Jump to bottom

[doc] Py_UTF8Mode is not documented #77782

Open
serhiy-storchaka opened this issue May 22, 2018 · 9 comments
Open

[doc] Py_UTF8Mode is not documented #77782

serhiy-storchaka opened this issue May 22, 2018 · 9 comments
Assignees
@Mariatta
Labels
3.9 3.10 3.11 docs easy type-feature

Comments

@serhiy-storchaka
Copy link
Member

@serhiy-storchaka serhiy-storchaka commented May 22, 2018

BPO 33601
Nosy @ncoghlan, @vstinner, @serhiy-storchaka, @Mariatta, @Vidhyavinu
PRs
  • #7143
  • #31480
    		•
    Files
  • init.html: c-api/init.html
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = 'https://github.com/Mariatta'
closed_at = None
created_at = <Date 2018-05-22.13:49:41.438>
labels = ['easy', '3.9', '3.10', '3.11', 'type-feature', 'docs']
title = '[doc] Py_UTF8Mode is not documented'
updated_at = <Date 2022-02-21.20:15:37.372>
user = 'https://github.com/serhiy-storchaka'

    bugs.python.org fields:

    activity = <Date 2022-02-21.20:15:37.372>
actor = 'vidhya'
assignee = 'Mariatta'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2018-05-22.13:49:41.438>
creator = 'serhiy.storchaka'
dependencies = []
files = ['50630']
hgrepos = []
issue_num = 33601
keywords = ['patch', 'easy']
message_count = 7.0
messages = ['317286', '317292', '317294', '338920', '413511', '413648', '413674']
nosy_count = 6.0
nosy_names = ['ncoghlan', 'vstinner', 'docs@python', 'serhiy.storchaka', 'Mariatta', 'vidhya']
pr_nums = ['7143', '31480']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue33601'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']
    @serhiy-storchaka
    Copy link
    Member Author

    @serhiy-storchaka serhiy-storchaka commented May 22, 2018

    Py_UTF8Mode was added to the limited API in 3.7, but it is not documented anywhere.

    @serhiy-storchaka serhiy-storchaka added 3.7 3.8 docs labels May 22, 2018
    @vstinner
    Copy link
    Member

    @vstinner vstinner commented May 22, 2018

    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

    @vstinner vstinner added the easy label May 22, 2018
    @vstinner vstinner changed the title Py_UTF8Mode is not documented [EASY DOC] Py_UTF8Mode is not documented May 22, 2018
    @serhiy-storchaka
    Copy link
    Member Author

    @serhiy-storchaka serhiy-storchaka commented May 22, 2018

    If there are reasons of including it in the limited API, it should be documented.

    @zooba zooba removed the easy label Jul 28, 2018
    @vstinner
    Copy link
    Member

    @vstinner vstinner commented Mar 26, 2019

    PR 7143 has been closed. So is there another candidate to write the doc?

    @csabella csabella assigned Mariatta and unassigned docspython Apr 8, 2019
    @csabella csabella added the type-feature label Apr 8, 2019
    @iritkatriel iritkatriel changed the title [EASY DOC] Py_UTF8Mode is not documented [doc] Py_UTF8Mode is not documented Jan 17, 2022
    @Vidhyavinu
    Copy link
    Mannequin

    @Vidhyavinu Vidhyavinu mannequin commented Feb 18, 2022

    [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.

    @vstinner
    Copy link
    Member

    @vstinner vstinner commented Feb 21, 2022

    [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.

    @Vidhyavinu
    Copy link
    Mannequin

    @Vidhyavinu Vidhyavinu mannequin commented Feb 21, 2022

    [Entry level contributor seeking guidance]The rst file is updated in this pull request:
    #31480

    Unable to update GitHub PR in the issue. Getting the following error "Edit Error: GitHub PR already added to issue"

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    vstinner added a commit to vstinner/cpython that referenced this issue May 23, 2022
    @vstinner
    pythongh-77782: Deprecate global configuration variable
    1b21793 
    Deprecate global configuration variable like
Py_IgnoreEnvironmentFlag: the Py_InitializeFromConfig() API should be
instead.
    vstinner added a commit to vstinner/cpython that referenced this issue May 23, 2022
    @vstinner
    pythongh-77782: Deprecate global configuration variable
    2ed458f 
    Deprecate global configuration variable like
Py_IgnoreEnvironmentFlag: the Py_InitializeFromConfig() API should be
instead.
    vstinner added a commit to vstinner/cpython that referenced this issue May 23, 2022
    @vstinner
    pythongh-77782: Deprecate global configuration variable
    4e306e6 
    Deprecate global configuration variable like Py_IgnoreEnvironmentFlag
in the documentation: the Py_InitializeFromConfig() API should be
instead.
    vstinner added a commit to vstinner/cpython that referenced this issue May 23, 2022
    @vstinner
    pythongh-77782: Deprecate global configuration variable
    c64d023 
    Deprecate global configuration variables, like
Py_IgnoreEnvironmentFlag, in the documentation: the
Py_InitializeFromConfig() API should be instead.
    @vstinner
    Copy link
    Member

    @vstinner vstinner commented May 23, 2022

    I created #93103 to deprecate Global Configuration Variables like Py_IgnoreEnvironment.

    vstinner added a commit to vstinner/cpython that referenced this issue May 23, 2022
    @vstinner
    pythongh-77782: Update PyUnicode_DecodeFSDefault() doc
    944dc5c 
    Update documentation of PyUnicode_DecodeFSDefault(),
PyUnicode_DecodeFSDefaultAndSize() and PyUnicode_EncodeFSDefault():
they now use the filesystem encoding and error handler of PyConfig,
Py_FileSystemDefaultEncoding and Py_FileSystemDefaultEncodeErrors
variables are no longer used.
    vstinner added a commit to vstinner/cpython that referenced this issue Jun 16, 2022
    @vstinner
    pythongh-77782: Py_FdIsInteractive() now uses PyConfig.interactive
    1e225e5
    vstinner added a commit to vstinner/cpython that referenced this issue Jun 16, 2022
    @vstinner
    pythongh-77782: Py_FdIsInteractive() now uses PyConfig.interactive
    c8638f3
    vstinner added a commit that referenced this issue Jun 17, 2022
    @vstinner
    gh-77782: Py_FdIsInteractive() now uses PyConfig.interactive (#93916)
    1735710
    vstinner added a commit to vstinner/cpython that referenced this issue Jun 17, 2022
    @vstinner
    pythongh-77782: Deprecate global configuration variable
    f730ac4 
    Deprecate global configuration variable like
Py_IgnoreEnvironmentFlag: the Py_InitializeFromConfig() API should be
instead.
    vstinner added a commit to vstinner/cpython that referenced this issue Jun 17, 2022
    @vstinner
    pythongh-77782: Deprecate global configuration variable
    2a89baa 
    Deprecate global configuration variable like
Py_IgnoreEnvironmentFlag: the Py_InitializeFromConfig() API should be
instead.

Fix declaration of Py_GETENV(): use PyAPI_FUNC(), not PyAPI_DATA().
    vstinner added a commit that referenced this issue Jun 17, 2022
    @vstinner
    gh-77782: Deprecate global configuration variable (#93943)
    0ff626f 
    Deprecate global configuration variable like
Py_IgnoreEnvironmentFlag: the Py_InitializeFromConfig() API should be
instead.

Fix declaration of Py_GETENV(): use PyAPI_FUNC(), not PyAPI_DATA().
    @vstinner
    Copy link
    Member

    @vstinner vstinner commented Jun 17, 2022

    I deprecated global configuration variables like Py_UTF8Mode in issue #93103 and PR #93943.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees

    @Mariatta Mariatta

    Labels
    3.9 3.10 3.11 docs easy type-feature
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    6 participants
    @vstinner @iritkatriel @zooba @serhiy-storchaka @Mariatta @csabella