Skip to content

Commit 1bb20e3

Browse files
committed
Document the jump parameter.
1 parent e73dfcd commit 1bb20e3

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

Doc/c-api/veryhigh.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -424,10 +424,13 @@ Stack Effects
424424
.. versionadded:: 3.4
425425
426426
427-
.. c:function:: int PyCompile_OpcodeStackEffectWithJump(int opcode, int oparg)
427+
.. c:function:: int PyCompile_OpcodeStackEffectWithJump(int opcode, int oparg, int jump)
428428
429429
Similar to :c:func:`PyCompile_OpcodeStackEffect`, but also includes the
430-
stack effect of jumping.
430+
stack effect of jumping depending on the value of *jump*.
431+
432+
If *jump* is ``0``, this will not include the stack effect of jumping, but
433+
if *jump* is ``1`` or ``-1``, this will include it.
431434
432435
On success, this function returns the stack effect; on failure, this
433436
returns :c:macro:`PY_INVALID_STACK_EFFECT`.

0 commit comments

Comments
 (0)