classification
Title: help for file/open should state which is prefered.
Type: Stage:
Components: Documentation Versions: Python 2.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: christian.heimes Nosy List: carlfk, christian.heimes, skip.montanaro (3)
Priority: normal Keywords:

Created on 2007-11-28 05:00 by carlfk, last changed 2007-12-08 14:38 by skip.montanaro.

Messages (3)
msg57901 - (view) Author: Carl Karsten (carlfk) Date: 2007-11-28 05:00 
bltinmodule.c:

PyDoc_STRVAR(open_doc,
"open(name[, mode[, buffering]]) -> file object\n\
\n\
Open a file using the file() type, returns a file object.");

Help for file() is detailed, which would lead people to use file over
open.  given that file() is removed in py3k, I think that should be
mentioned in the current file() docstring, and swap the help for file/open.
msg57906 - (view) Author: Christian Heimes (christian.heimes) Date: 2007-11-28 09:46 
I agree!

Can you provide a patch please?
msg58294 - (view) Author: Skip Montanaro (skip.montanaro) Date: 2007-12-08 14:38 
updated docstrings for file and open (r59417).
History
Date User Action Args
2007-12-08 14:38:19skip.montanarosetstatus: open -> closed
resolution: fixed
messages: + msg58294
nosy: + skip.montanaro
2007-11-28 09:46:24christian.heimessetpriority: normal
assignee: christian.heimes
messages: + msg57906
nosy: + christian.heimes
2007-11-28 05:00:44carlfkcreate