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: link to "file object" glossary entry in open() and io docs
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.2, Python 3.3
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: chris.jerdonek, docs@python, eric.araujo, pitrou, python-dev, r.david.murray
Priority: normal Keywords: easy, patch

Created on 2012-08-16 16:06 by chris.jerdonek, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue-15694-1.patch chris.jerdonek, 2012-08-16 19:31 review
Messages (7)
msg168392 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-08-16 16:06
It would be nice if the first sentence of the documentation for the open() built-in function:

"Open file and return a corresponding stream. If the file cannot be opened, an OSError is raised."

http://docs.python.org/dev/library/functions.html#open

linked to the glossary entry for "file object":

http://docs.python.org/dev/glossary.html#term-file-object

Incidentally, this would be similar to what was done 2.7 documentation of open():

http://docs.python.org/library/functions.html#open

Similarly, the introductory overview section of the io module should also link to the glossary entry for "file object":

"Concrete objects belonging to any of these categories will often be called streams; another common term is file-like objects."

(from http://docs.python.org/dev/library/io.html#overview )
msg168401 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-08-16 19:31
Attaching patch.  I also added two index entries for "file object" and made a couple wording adjustments to the intro paragraph of the io module.
msg168452 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2012-08-17 17:54
LGTM.
msg168469 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2012-08-17 19:24
LGTM too.
msg168485 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-08-17 23:14
Thanks. Could either one of you commit this for me?
msg168486 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2012-08-18 00:40
New changeset 1d5c451a1365 by R David Murray in branch '3.2':
#15694: Link discussion of file objects to glossary entry.
http://hg.python.org/cpython/rev/1d5c451a1365

New changeset 977606940531 by R David Murray in branch 'default':
Merge #15694: Link discussion of file objects to glossary entry.
http://hg.python.org/cpython/rev/977606940531

New changeset 083c37e75c49 by R David Murray in branch '3.2':
#15694: reflow paragraph.
http://hg.python.org/cpython/rev/083c37e75c49

New changeset d57ea50bc526 by R David Murray in branch 'default':
Merge #15694: reflow paragraph.
http://hg.python.org/cpython/rev/d57ea50bc526
msg168487 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2012-08-18 00:40
Thanks, Chris.
History
Date User Action Args
2022-04-11 14:57:34adminsetgithub: 59899
2012-08-18 00:40:55r.david.murraysetstatus: open -> closed

nosy: + r.david.murray
messages: + msg168487

resolution: fixed
stage: patch review -> resolved
2012-08-18 00:40:18python-devsetnosy: + python-dev
messages: + msg168486
2012-08-17 23:14:24chris.jerdoneksetmessages: + msg168485
2012-08-17 19:24:16pitrousetmessages: + msg168469
2012-08-17 17:54:09eric.araujosetnosy: + eric.araujo, pitrou
messages: + msg168452
2012-08-16 19:31:34chris.jerdoneksetfiles: + issue-15694-1.patch
versions: + Python 3.2
messages: + msg168401

keywords: + patch
stage: patch review
2012-08-16 16:06:44chris.jerdoneksetkeywords: + easy
2012-08-16 16:06:31chris.jerdonekcreate