Issue #22413: Merge StringIO doc from 3.4 into 3.5

1 files changed, 6 insertions, 1 deletions

diff --git a/Modules/_io/_iomodule.h b/Modules/_io/_iomodule.h
index 9d5205ec30..0c6eae26b7 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);