Issue #22413: Document newline effect on StringIO initializer and getvalue

Also add to comment in the C code.
This commit is contained in:
Martin Panter 2015-10-10 03:01:20 +00:00
parent e44dba3b4f
commit cfad54344f
2 changed files with 18 additions and 5 deletions

View file

@ -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);