[ python-Bugs-1622533 ] null bytes in docstrings

[SourceForge.net]

Bugs item #1622533, was opened at 2006-12-26 12:47
Message generated for change (Comment added) made by rhettinger
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1622533&group_id=5470

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Python Library
Group: None
Status: Open
Resolution: None
Priority: 5
Private: No
Submitted By: Fredrik Lundh (effbot)
Assigned to: Nobody/Anonymous (nobody)
Summary: null bytes in docstrings

Initial Comment:
the following docstrings contain bogus control characters:

module difflib, function _mdiff, contains four invalid bytes:

    ['\x00', '\x00', '\x00', '\x01']

module StringIO, method readline, contains a null byte:

    ['\x00']

since this breaks help() and probably a bunch of other documentation tools, it would probably be a good idea to add the missing backslashes...

----------------------------------------------------------------------

>Comment By: Raymond Hettinger (rhettinger)
Date: 2006-12-26 13:27

Message:
Logged In: YES 
user_id=80475
Originator: NO

Clearer and simpler to make the whole docstring raw.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1622533&group_id=5470