[New-bugs-announce] [issue15694] link to "file object" glossary entry in open() and io docs

[Chris Jerdonek]

New submission from Chris Jerdonek:

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 )

----------
assignee: docs at python
components: Documentation
messages: 168392
nosy: cjerdonek, docs at python
priority: normal
severity: normal
status: open
title: link to "file object" glossary entry in open() and io docs
type: enhancement
versions: Python 3.3

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue15694>
_______________________________________