Escaped backslashes in docstrings.
This commit is contained in:
parent
72dcb0a765
commit
9f8a8910a4
|
@ -324,7 +324,7 @@ def a85encode(b, *, foldspaces=False, wrapcol=0, pad=False, adobe=False):
|
||||||
instead of 4 consecutive spaces (ASCII 0x20) as supported by 'btoa'. This
|
instead of 4 consecutive spaces (ASCII 0x20) as supported by 'btoa'. This
|
||||||
feature is not supported by the "standard" Adobe encoding.
|
feature is not supported by the "standard" Adobe encoding.
|
||||||
|
|
||||||
wrapcol controls whether the output should have newline ('\n') characters
|
wrapcol controls whether the output should have newline ('\\n') characters
|
||||||
added to it. If this is non-zero, each output line will be at most this
|
added to it. If this is non-zero, each output line will be at most this
|
||||||
many characters long.
|
many characters long.
|
||||||
|
|
||||||
|
@ -434,7 +434,7 @@ _b85dec = None
|
||||||
def b85encode(b, pad=False):
|
def b85encode(b, pad=False):
|
||||||
"""Encode an ASCII-encoded byte array in base85 format.
|
"""Encode an ASCII-encoded byte array in base85 format.
|
||||||
|
|
||||||
If pad is true, the input is padded with "\0" so its length is a multiple of
|
If pad is true, the input is padded with "\\0" so its length is a multiple of
|
||||||
4 characters before encoding.
|
4 characters before encoding.
|
||||||
"""
|
"""
|
||||||
global _b85chars, _b85chars2
|
global _b85chars, _b85chars2
|
||||||
|
|
|
@ -1061,7 +1061,7 @@ def make_encoding_map(decoding_map):
|
||||||
during translation.
|
during translation.
|
||||||
|
|
||||||
One example where this happens is cp875.py which decodes
|
One example where this happens is cp875.py which decodes
|
||||||
multiple character to \u001a.
|
multiple character to \\u001a.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
m = {}
|
m = {}
|
||||||
|
|
|
@ -152,7 +152,7 @@ def decode(ew):
|
||||||
then from the resulting bytes into unicode using the specified charset. If
|
then from the resulting bytes into unicode using the specified charset. If
|
||||||
the cte-decoded string does not successfully decode using the specified
|
the cte-decoded string does not successfully decode using the specified
|
||||||
character set, a defect is added to the defects list and the unknown octets
|
character set, a defect is added to the defects list and the unknown octets
|
||||||
are replaced by the unicode 'unknown' character \uFDFF.
|
are replaced by the unicode 'unknown' character \\uFDFF.
|
||||||
|
|
||||||
The specified charset and language are returned. The default for language,
|
The specified charset and language are returned. The default for language,
|
||||||
which is rarely if ever encountered, is the empty string.
|
which is rarely if ever encountered, is the empty string.
|
||||||
|
|
|
@ -191,7 +191,7 @@ def search_reverse(prog, chars, col):
|
||||||
|
|
||||||
This is done by searching forwards until there is no match.
|
This is done by searching forwards until there is no match.
|
||||||
Prog: compiled re object with a search method returning a match.
|
Prog: compiled re object with a search method returning a match.
|
||||||
Chars: line of text, without \n.
|
Chars: line of text, without \\n.
|
||||||
Col: stop index for the search; the limit for match.end().
|
Col: stop index for the search; the limit for match.end().
|
||||||
'''
|
'''
|
||||||
m = prog.search(chars)
|
m = prog.search(chars)
|
||||||
|
|
|
@ -518,8 +518,8 @@ class SMTP:
|
||||||
Raises SMTPDataError if there is an unexpected reply to the
|
Raises SMTPDataError if there is an unexpected reply to the
|
||||||
DATA command; the return value from this method is the final
|
DATA command; the return value from this method is the final
|
||||||
response code received when the all data is sent. If msg
|
response code received when the all data is sent. If msg
|
||||||
is a string, lone '\r' and '\n' characters are converted to
|
is a string, lone '\\r' and '\\n' characters are converted to
|
||||||
'\r\n' characters. If msg is bytes, it is transmitted as is.
|
'\\r\\n' characters. If msg is bytes, it is transmitted as is.
|
||||||
"""
|
"""
|
||||||
self.putcmd("data")
|
self.putcmd("data")
|
||||||
(code, repl) = self.getreply()
|
(code, repl) = self.getreply()
|
||||||
|
|
|
@ -1379,7 +1379,7 @@ def captured_stdout():
|
||||||
|
|
||||||
with captured_stdout() as stdout:
|
with captured_stdout() as stdout:
|
||||||
print("hello")
|
print("hello")
|
||||||
self.assertEqual(stdout.getvalue(), "hello\n")
|
self.assertEqual(stdout.getvalue(), "hello\\n")
|
||||||
"""
|
"""
|
||||||
return captured_output("stdout")
|
return captured_output("stdout")
|
||||||
|
|
||||||
|
@ -1388,7 +1388,7 @@ def captured_stderr():
|
||||||
|
|
||||||
with captured_stderr() as stderr:
|
with captured_stderr() as stderr:
|
||||||
print("hello", file=sys.stderr)
|
print("hello", file=sys.stderr)
|
||||||
self.assertEqual(stderr.getvalue(), "hello\n")
|
self.assertEqual(stderr.getvalue(), "hello\\n")
|
||||||
"""
|
"""
|
||||||
return captured_output("stderr")
|
return captured_output("stderr")
|
||||||
|
|
||||||
|
@ -1396,7 +1396,7 @@ def captured_stdin():
|
||||||
"""Capture the input to sys.stdin:
|
"""Capture the input to sys.stdin:
|
||||||
|
|
||||||
with captured_stdin() as stdin:
|
with captured_stdin() as stdin:
|
||||||
stdin.write('hello\n')
|
stdin.write('hello\\n')
|
||||||
stdin.seek(0)
|
stdin.seek(0)
|
||||||
# call test code that consumes from sys.stdin
|
# call test code that consumes from sys.stdin
|
||||||
captured = input()
|
captured = input()
|
||||||
|
|
|
@ -133,7 +133,7 @@ class TextWrapper:
|
||||||
"""_munge_whitespace(text : string) -> string
|
"""_munge_whitespace(text : string) -> string
|
||||||
|
|
||||||
Munge whitespace in text: expand tabs and convert all other
|
Munge whitespace in text: expand tabs and convert all other
|
||||||
whitespace characters to spaces. Eg. " foo\tbar\n\nbaz"
|
whitespace characters to spaces. Eg. " foo\\tbar\\n\\nbaz"
|
||||||
becomes " foo bar baz".
|
becomes " foo bar baz".
|
||||||
"""
|
"""
|
||||||
if self.expand_tabs:
|
if self.expand_tabs:
|
||||||
|
@ -169,7 +169,7 @@ class TextWrapper:
|
||||||
"""_fix_sentence_endings(chunks : [string])
|
"""_fix_sentence_endings(chunks : [string])
|
||||||
|
|
||||||
Correct for sentence endings buried in 'chunks'. Eg. when the
|
Correct for sentence endings buried in 'chunks'. Eg. when the
|
||||||
original text contains "... foo.\nBar ...", munge_whitespace()
|
original text contains "... foo.\\nBar ...", munge_whitespace()
|
||||||
and split() will convert that to [..., "foo.", " ", "Bar", ...]
|
and split() will convert that to [..., "foo.", " ", "Bar", ...]
|
||||||
which has one too few spaces; this method simply changes the one
|
which has one too few spaces; this method simply changes the one
|
||||||
space to two.
|
space to two.
|
||||||
|
@ -405,7 +405,7 @@ def dedent(text):
|
||||||
in indented form.
|
in indented form.
|
||||||
|
|
||||||
Note that tabs and spaces are both treated as whitespace, but they
|
Note that tabs and spaces are both treated as whitespace, but they
|
||||||
are not equal: the lines " hello" and "\thello" are
|
are not equal: the lines " hello" and "\\thello" are
|
||||||
considered to have no common leading whitespace. (This behaviour is
|
considered to have no common leading whitespace. (This behaviour is
|
||||||
new in Python 2.5; older versions of this module incorrectly
|
new in Python 2.5; older versions of this module incorrectly
|
||||||
expanded tabs before searching for common leading whitespace.)
|
expanded tabs before searching for common leading whitespace.)
|
||||||
|
|
Loading…
Reference in New Issue