summaryrefslogtreecommitdiffstats
path: root/Python/marshal.c
diff options
context:
space:
mode:
authorIrit Katriel <1055913+iritkatriel@users.noreply.github.com>2023-06-02 07:59:18 (GMT)
committerGitHub <noreply@github.com>2023-06-02 07:59:18 (GMT)
commitee26ca13a129da8cf549409d0a1b2e892ff2b4ec (patch)
tree77aefc5286e6c2fa6b0c653c2123c25a51a49f84 /Python/marshal.c
parent77d25795862f19c6e3d647b76cfb10d5ce1f149c (diff)
downloadcpython-ee26ca13a129da8cf549409d0a1b2e892ff2b4ec.zip
cpython-ee26ca13a129da8cf549409d0a1b2e892ff2b4ec.tar.gz
cpython-ee26ca13a129da8cf549409d0a1b2e892ff2b4ec.tar.bz2
gh-105184: document that marshal functions can fail and need to be checked with PyErr_Occurred (#105185)
Diffstat (limited to 'Python/marshal.c')
-rw-r--r--Python/marshal.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/Python/marshal.c b/Python/marshal.c
index 208996b..6439503 100644
--- a/Python/marshal.c
+++ b/Python/marshal.c
@@ -625,6 +625,10 @@ w_clear_refs(WFILE *wf)
}
/* version currently has no effect for writing ints. */
+/* Note that while the documentation states that this function
+ * can error, currently it never does. Setting an exception in
+ * this function should be regarded as an API-breaking change.
+ */
void
PyMarshal_WriteLongToFile(long x, FILE *fp, int version)
{