Minor problems with PyFileObject documentation (Doc/c-api/file.rst)

[pebolle]

BPO	10111
Nosy	@birkenfeld, @pitrou
Files	python-2.7-Doc-gil.patch: minor documentation fixes

^{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 2010-10-15.17:53:12.900>
created_at = <Date 2010-10-15.06:50:05.967>
labels = ['docs']
title = 'Minor problems with PyFileObject documentation (Doc/c-api/file.rst)'
updated_at = <Date 2010-10-15.17:53:12.859>
user = 'https://bugs.python.org/pebolle'

bugs.python.org fields:

activity = <Date 2010-10-15.17:53:12.859>
actor = 'georg.brandl'
assignee = 'docs@python'
closed = True
closed_date = <Date 2010-10-15.17:53:12.900>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2010-10-15.06:50:05.967>
creator = 'pebolle'
dependencies = []
files = ['19241']
hgrepos = []
issue_num = 10111
keywords = ['patch']
message_count = 2.0
messages = ['118742', '118811']
nosy_count = 4.0
nosy_names = ['georg.brandl', 'pitrou', 'docs@python', 'pebolle']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue10111'
versions = ['Python 2.7']

[pebolle]

0. I ran into some (small) problems with the documentation added by revision 62195 (see bpo-815646 for background).

1. A small patch that addresses two problems with the Python 2.7 documentation should be attached:

• link three occurrences of "GIL" to the GIL entry in the glossary; and
• add some example code to clarify the usage of PyFile_IncUseCount() andPyFile_DecUseCount().

2. That patch also adds a link to the "Thread State and the Global Interpreter Lock" section to the GIL entry in the Documentation index. That is a separate problem. But fixing that minor problem could also be of help to people (like me) that need to better understand the GIL aspects of those two functions.

[birkenfeld]

Committed in r85545.