summaryrefslogtreecommitdiff
path: root/jq.pyx
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2026-07-10 17:56:33 +0100
committerMichael Williamson <mike@zwobble.org>2026-07-10 17:56:33 +0100
commit40f4b9da27f54b57cc682e5642a2b181d4488de8 (patch)
tree53ffe79fadd58c157343d571a50c604c56a70a78 /jq.pyx
parentce103eb293f536bf34ca125d9461674037119e9b (diff)
Document that _jv_to_python() consumes its input
Diffstat (limited to 'jq.pyx')
-rw-r--r--jq.pyx5
1 files changed, 4 insertions, 1 deletions
diff --git a/jq.pyx b/jq.pyx
index 8f7ebb8..2780a53 100644
--- a/jq.pyx
+++ b/jq.pyx
@@ -70,7 +70,10 @@ cdef extern from "jq.h":
cdef object _jv_to_python(jv value):
- """Unpack a jv value into a Python value"""
+ """Unpack a jv value into a Python value.
+
+ Consumes the input value."""
+
cdef jv_kind kind = jv_get_kind(value)
cdef int idx
cdef jv property_key