[issue9715] io doc improvements

2010-08-30 Thread Antoine Pitrou
Antoine Pitrou added the comment: > File I/O and memory I/O would have more uniform in their APIs and thus be > easier to document, describe and use. Currently, one class is used to do > file I/O. That's wrong. Various classes are used for file I/O: FileIO, Buffered{Reader,Writer,Random}, Text

[issue9715] io doc improvements

2010-08-30 Thread Skip Montanaro
Skip Montanaro added the comment: >> Finally, not specific to this change, but I wonder if rather than >> having distinct io.StringIO and io.BytesIO classes it would be better >> to have a single io.MemoryIO class which takes mode arguments just >> like io.FileIO?  The correspondenc

[issue9715] io doc improvements

2010-08-30 Thread Antoine Pitrou
Antoine Pitrou added the comment: > "The default mode is ``'r'`` (open for reading text, synonym of > ``'rt'``)". I liked the original wording better. Well, people use "r" in practice, and "rt" is a somewhat rarer alternative. We could drop the "synonym..." part entirely. --

[issue9715] io doc improvements

2010-08-30 Thread Benjamin Peterson
Benjamin Peterson added the comment: 2010/8/30 Skip Montanaro : > > Skip Montanaro added the comment: > > A couple wording comments: > > "All streams are careful about the type of data you give to them" > would read better as "All streams accept specific types of data". > > "The default mode is

[issue9715] io doc improvements

2010-08-30 Thread Skip Montanaro
Skip Montanaro added the comment: A couple wording comments: "All streams are careful about the type of data you give to them" would read better as "All streams accept specific types of data". "The default mode is ``'r'`` (open for reading text, synonym of ``'rt'``)". I liked the original wor

[issue9715] io doc improvements

2010-08-30 Thread Antoine Pitrou
Antoine Pitrou added the comment: Ok, committed in r84357 (py3k) and r84358 (3.1). Backporting to 2.7 would be too much work. -- resolution: -> fixed stage: patch review -> committed/rejected status: open -> closed versions: -Python 2.7 ___ Python

[issue9715] io doc improvements

2010-08-30 Thread Antoine Pitrou
Changes by Antoine Pitrou : Added file: http://bugs.python.org/file18680/iodoc.patch ___ Python tracker ___ ___ Python-bugs-list mailing list U

[issue9715] io doc improvements

2010-08-30 Thread Antoine Pitrou
Changes by Antoine Pitrou : Removed file: http://bugs.python.org/file18679/iodoc.patch ___ Python tracker ___ ___ Python-bugs-list mailing list

[issue9715] io doc improvements

2010-08-30 Thread Antoine Pitrou
New submission from Antoine Pitrou : This is an improvement patch for the :mod:`io` documentation. It adds an user-friendly overview, and makes a couple of other fixes/improvements. There's a problem where I want to make a link to a glossary term while using the plural form ("abstract base clas