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

Update 'file object' doc #51757

Closed
terryjreedy opened this issue Dec 15, 2009 · 6 comments
Closed

Update 'file object' doc #51757

terryjreedy opened this issue Dec 15, 2009 · 6 comments
Assignees
Labels
docs Documentation in the Doc dir

Comments

@terryjreedy
Copy link
Member

BPO 7508
Nosy @birkenfeld, @terryjreedy, @pitrou

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 = 'https://github.com/pitrou'
closed_at = <Date 2009-12-19.18:23:35.672>
created_at = <Date 2009-12-15.04:43:42.301>
labels = ['docs']
title = "Update 'file object' doc"
updated_at = <Date 2009-12-19.18:23:35.671>
user = 'https://github.com/terryjreedy'

bugs.python.org fields:

activity = <Date 2009-12-19.18:23:35.671>
actor = 'pitrou'
assignee = 'pitrou'
closed = True
closed_date = <Date 2009-12-19.18:23:35.672>
closer = 'pitrou'
components = ['Documentation']
creation = <Date 2009-12-15.04:43:42.301>
creator = 'terry.reedy'
dependencies = []
files = []
hgrepos = []
issue_num = 7508
keywords = []
message_count = 6.0
messages = ['96419', '96617', '96624', '96626', '96629', '96636']
nosy_count = 3.0
nosy_names = ['georg.brandl', 'terry.reedy', 'pitrou']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue7508'
versions = ['Python 3.1', 'Python 3.2']

@terryjreedy
Copy link
Member Author

"5.9. File Objects¶
File objects are implemented using C’s stdio package and can be created
with the built-in open() function."

As I understand, the part about stdio is no longer true.
Also, as I understand, there is no longer a class <file> object.
Rather there are various io (or _io) classes returned by open depending
on the args, especially the mode. This should be made clear. Something like

"File objects are created by the built-in open function and others.
There are instances of various classes exposed in the io module. The
following discusses the methods common to various file objects."

Maybe even retitle the section "IO objects" and use 'io' instead of
'file' as the prefix for method names.

Maybe whoever wrote the new io system could check this section for accuracy.

@terryjreedy terryjreedy added the docs Documentation in the Doc dir label Dec 15, 2009
@birkenfeld
Copy link
Member

Maybe Antoine wants (!) to look at it.

@birkenfeld birkenfeld assigned pitrou and unassigned birkenfeld Dec 19, 2009
@pitrou
Copy link
Member

pitrou commented Dec 19, 2009

In which part/filename of the doc can I find this extract?

@pitrou
Copy link
Member

pitrou commented Dec 19, 2009

Okay, I've found it. IMO this section should simply be removed, since
the file type doesn't exist anymore.

@pitrou
Copy link
Member

pitrou commented Dec 19, 2009

Note: one issue is that io.rst is currently some kind of technical
reference about base classes and stuff, it is unreadable for anyone
looking for simple information.

@pitrou
Copy link
Member

pitrou commented Dec 19, 2009

I've removed it in r76893. Thanks!

@pitrou pitrou closed this as completed Dec 19, 2009
@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
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

No branches or pull requests

3 participants