PyGILState_GetThisThreadState() lacks a doc entry

[pitrou]

BPO	10741
Nosy	@pitrou, @vstinner, @ezio-melotti, @sandrotosi
Files	issue10741-default.patch

^{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 2011-08-07.22:22:13.028>
created_at = <Date 2010-12-20.18:09:49.356>
labels = ['docs']
title = 'PyGILState_GetThisThreadState() lacks a doc entry'
updated_at = <Date 2011-08-07.22:22:13.026>
user = 'https://github.com/pitrou'

bugs.python.org fields:

activity = <Date 2011-08-07.22:22:13.026>
actor = 'sandro.tosi'
assignee = 'docs@python'
closed = True
closed_date = <Date 2011-08-07.22:22:13.028>
closer = 'sandro.tosi'
components = ['Documentation']
creation = <Date 2010-12-20.18:09:49.356>
creator = 'pitrou'
dependencies = []
files = ['22858']
hgrepos = []
issue_num = 10741
keywords = ['patch']
message_count = 4.0
messages = ['124394', '141748', '141751', '141752']
nosy_count = 6.0
nosy_names = ['pitrou', 'vstinner', 'ezio.melotti', 'sandro.tosi', 'docs@python', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue10741'
versions = ['Python 2.7', 'Python 3.2', 'Python 3.3']

[pitrou]

PyGILState_GetThisThreadState() is "documented" in Include/pystate.h but not in the official docs. It should be documented along PyGILState_Ensure() and friends.

[sandrotosi]

Here attached a very simple patch, made by slightly re-editing the comment in pystate.h.

[python-dev]

New changeset 8852e4a9aa1e by Sandro Tosi in branch '2.7':
bpo-10741: add documentation for PyGILState_GetThisThreadState()
http://hg.python.org/cpython/rev/8852e4a9aa1e

New changeset 53b8260b9ea7 by Sandro Tosi in branch '3.2':
bpo-10741: add documentation for PyGILState_GetThisThreadState()
http://hg.python.org/cpython/rev/53b8260b9ea7

New changeset 6adfeec8c482 by Sandro Tosi in branch 'default':
bpo-10741: merge with 3.2
http://hg.python.org/cpython/rev/6adfeec8c482

[sandrotosi]

I just committed an improved version of the proposed patch (thanks Ezio for the review and help!).