[docs] [issue12855] linebreak sequences should be better documented

Matthew Boehm report at bugs.python.org
Wed Aug 31 04:35:38 CEST 2011

Matthew Boehm <boehm.matthew at gmail.com> added the comment:

I've attached a patch for 2.7 and will attach one for 3.2 in a minute.

I built the docs for both 2.7 and 3.2 and verified that there were no warnings and that the resulting web pages looked okay.

Things to consider:

* Placement of unicode.splitlines() method: I placed it next to str.splitlines. I didn't want to place it with the unicode methods further down because docs say "The following methods are present only on unicode objects"

* The docs for codecs.readlines() already mentions "Line-endings are implemented using the codec’s decoder method and are included in the list entries if keepends is true." 

* Feel free to make any wording/style suggestions.

Added file: http://bugs.python.org/file23076/linebreakdoc.v2.py27.patch

Python tracker <report at bugs.python.org>

More information about the docs mailing list