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

Improve documentation of PyContextVar C-API #88125

Closed
scoder opened this issue Apr 27, 2021 · 4 comments
Closed

Improve documentation of PyContextVar C-API #88125

scoder opened this issue Apr 27, 2021 · 4 comments
Labels
3.8 only security fixes 3.9 only security fixes 3.10 only security fixes 3.11 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@scoder
Copy link
Contributor

scoder commented Apr 27, 2021

BPO 43959
Nosy @scoder, @miss-islington
PRs
  • bpo-43959: clarify the documentation of the PyContextVar C-API #25671
  • [3.9] bpo-43959: clarify the documentation of the PyContextVar C-API (GH-25671) #25689
  • [3.8] bpo-43959: clarify the documentation of the PyContextVar C-API (GH-25671) #25690
    		•

    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 = None
closed_at = <Date 2021-04-28.15:18:17.655>
created_at = <Date 2021-04-27.20:13:25.640>
labels = ['3.8', '3.9', '3.10', '3.11', 'type-feature', 'docs']
title = 'Improve documentation of PyContextVar C-API'
updated_at = <Date 2021-04-28.15:18:17.655>
user = 'https://github.com/scoder'

    bugs.python.org fields:

    activity = <Date 2021-04-28.15:18:17.655>
actor = 'scoder'
assignee = 'docs@python'
closed = True
closed_date = <Date 2021-04-28.15:18:17.655>
closer = 'scoder'
components = ['Documentation']
creation = <Date 2021-04-27.20:13:25.640>
creator = 'scoder'
dependencies = []
files = []
hgrepos = []
issue_num = 43959
keywords = ['patch']
message_count = 4.0
messages = ['392128', '392202', '392210', '392211']
nosy_count = 3.0
nosy_names = ['scoder', 'docs@python', 'miss-islington']
pr_nums = ['25671', '25689', '25690']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue43959'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10', 'Python 3.11']
    @scoder
    Copy link
    Contributor Author

    scoder commented Apr 27, 2021

    The documentation of the PyContextVar C-API is unclear in a couple of places.

    • It's not clear whether PyContextVar_Get() always returns an owned reference also for default values or only if a value was found.
    • It's not explicit that "optional" actually means "pass an object reference or NULL".
    • The return value of PyContextVar_Set() is not explained.

    @scoder scoder added 3.8 only security fixes 3.9 only security fixes 3.10 only security fixes 3.11 only security fixes labels Apr 27, 2021
    @scoder scoder added docs Documentation in the Doc dir 3.8 only security fixes type-feature A feature request or enhancement 3.9 only security fixes 3.10 only security fixes 3.11 only security fixes labels Apr 27, 2021
    @scoder scoder added the docs Documentation in the Doc dir label Apr 27, 2021
    @miss-islington
    Copy link
    Contributor

    New changeset 4c49be7 by scoder in branch 'master':
    bpo-43959: clarify the documentation of the PyContextVar C-API (GH-25671)
    4c49be7

    @scoder
    Copy link
    Contributor Author

    scoder commented Apr 28, 2021

    New changeset fdb1189 by Miss Islington (bot) in branch '3.9':
    bpo-43959: clarify the documentation of the PyContextVar C-API (GH-25671) (GH-25689)
    fdb1189

    @scoder
    Copy link
    Contributor Author

    scoder commented Apr 28, 2021

    New changeset ff7266e by Miss Islington (bot) in branch '3.8':
    bpo-43959: clarify the documentation of the PyContextVar C-API (GH-25671) (GH-25690)
    ff7266e

    @scoder scoder closed this as completed Apr 28, 2021
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.8 only security fixes 3.9 only security fixes 3.10 only security fixes 3.11 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @scoder @miss-islington