diff options
| author | Martin Panter <vadmium+py@gmail.com> | 2015-10-10 10:15:21 (GMT) |
|---|---|---|
| committer | Martin Panter <vadmium+py@gmail.com> | 2015-10-10 10:15:21 (GMT) |
| commit | 994815e1d713428600386e9909b935e4dfe7c82d (patch) | |
| tree | 274c577da68b7677123e88af723732c8b2ee2bbc /Modules/_io/_iomodule.h | |
| parent | 3cae7577723e094f6fab24001eb152efb23248a1 (diff) | |
| parent | cfad54344f570c1e833d92289ac571da7315b164 (diff) | |
| download | cpython-994815e1d713428600386e9909b935e4dfe7c82d.zip cpython-994815e1d713428600386e9909b935e4dfe7c82d.tar.gz cpython-994815e1d713428600386e9909b935e4dfe7c82d.tar.bz2 | |
Issue #22413: Merge StringIO doc from 3.4 into 3.5
Diffstat (limited to 'Modules/_io/_iomodule.h')
| -rw-r--r-- | Modules/_io/_iomodule.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/Modules/_io/_iomodule.h b/Modules/_io/_iomodule.h index 9d5205e..0c6eae2 100644 --- a/Modules/_io/_iomodule.h +++ b/Modules/_io/_iomodule.h @@ -52,7 +52,12 @@ extern PyObject *_PyIncrementalNewlineDecoder_decode( which can be safely put aside until another search. NOTE: for performance reasons, `end` must point to a NUL character ('\0'). - Otherwise, the function will scan further and return garbage. */ + Otherwise, the function will scan further and return garbage. + + There are three modes, in order of priority: + * translated: Only find \n (assume newlines already translated) + * universal: Use universal newlines algorithm + * Otherwise, the line ending is specified by readnl, a str object */ extern Py_ssize_t _PyIO_find_line_ending( int translated, int universal, PyObject *readnl, int kind, char *start, char *end, Py_ssize_t *consumed); |