Skip to content

Commit 98cf1db

Browse files
committed
correct docs for nqp_bigint_radix
1 parent 8534217 commit 98cf1db

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/ops/nqp_bigint.ops

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,8 +226,11 @@ inline op nqp_bigint_bnot(out PMC, in PMC) :base_cor {
226226
=item nqp_bigint_radix(out, radix, str, pos, flag, type)
227227

228228
Convert string $3 into a number starting at offset $4 and using radix $2.
229-
The result of the conversion returns an object of type $6, which is either
230-
a bigint or some type that boxes one.
229+
The result of the conversion returns a FixedPMCArray of size 3 with objects
230+
of type $6, which is either a bigint or some type that boxes one.
231+
232+
The contents of $6 are the return value, the base to divide the value by if
233+
it is something after a decimal dot, and the new position.
231234

232235
The $5 flags is a bitmask that modifies the parse and/or result:
233236
0x01: negate the result (useful if you've already parsed a minus)

0 commit comments

Comments
 (0)