This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: null bytes in docstrings
Type: Stage:
Components: Library (Lib) Versions: Python 2.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: akuchling Nosy List: akuchling, effbot, rhettinger
Priority: normal Keywords:

Created on 2006-12-26 17:47 by effbot, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (3)
msg30866 - (view) Author: Fredrik Lundh (effbot) * (Python committer) Date: 2006-12-26 17:47
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...
msg30867 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2006-12-26 18:27
Clearer and simpler to make the whole docstring raw.
msg30868 - (view) Author: A.M. Kuchling (akuchling) * (Python committer) Date: 2007-01-05 14:24
Fixed in trunk rev. 53262, 25-maint rev. 53263.  Thanks!
History
Date User Action Args
2022-04-11 14:56:21adminsetgithub: 44379
2006-12-26 17:47:22effbotcreate