Merge pull request #503 from AllenX2018/loadfd-doc

add note for non-blocking file descriptor used for json_loadfd
akheron · Oct 17, 2019 · 92873e9 · 92873e9
2 parents 9e1c37c + b403bbb
commit 92873e9
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/doc/apiref.rst b/doc/apiref.rst
@@ -1333,7 +1333,11 @@ If no error or position information is needed, you can pass *NULL*.
    It is important to note that this function can only succeed on stream
    file descriptors (such as SOCK_STREAM). Using this function on a
    non-stream file descriptor will result in undefined behavior. For
-   non-stream file descriptors, see instead :func:`json_loadb()`.
+   non-stream file descriptors, see instead :func:`json_loadb()`. In
+   addition, please note that this function cannot be used on non-blocking 
+   file descriptors (such as a non-blocking socket). Using this function 
+   on non-blocking file descriptors has a high risk of data loss because 
+   it does not support resuming.
 
    This function requires POSIX and fails on all non-POSIX systems.