Skip to content

Commit 1d261a8

Browse files
bobzhangclaude
andcommitted
docs(bigint): align from_octets docstring parameter names with signature
The docstring referred to `bytes`/`sign` while the actual parameters are `input`/`signum`. Addresses Copilot review comments on #4115. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 2d80f71 commit 1d261a8

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

bigint/bigint_nonjs.mbt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1427,17 +1427,17 @@ pub fn BigInt::pow(self : BigInt, exp : BigInt, modulus? : BigInt) -> BigInt {
14271427
///
14281428
/// Parameters:
14291429
///
1430-
/// * `bytes` : A sequence of bytes representing the magnitude of the number in
1430+
/// * `input` : A sequence of bytes representing the magnitude of the number in
14311431
/// big-endian order. An empty sequence represents a zero magnitude.
1432-
/// * `sign` : An integer specifying the sign of the resulting number (default:
1433-
/// 1). A value of 1 creates a positive number, -1 creates a negative number, and
1434-
/// 0 returns zero regardless of the input bytes.
1432+
/// * `signum` : An integer specifying the sign of the resulting number
1433+
/// (default: 1). A positive value creates a positive number, a negative value
1434+
/// creates a negative number, and 0 returns zero regardless of the input bytes.
14351435
///
14361436
/// Returns a `BigInt` value representing the number encoded in the byte sequence
14371437
/// with the specified sign.
14381438
///
1439-
/// An empty byte sequence yields zero for any `sign`, matching the behavior of
1440-
/// Java's `BigInteger`, Python's `int.from_bytes`, and Rust's `num-bigint`.
1439+
/// An empty byte sequence yields zero for any `signum`, matching the behavior
1440+
/// of Java's `BigInteger`, Python's `int.from_bytes`, and Rust's `num-bigint`.
14411441
///
14421442
/// Example:
14431443
///

0 commit comments

Comments
 (0)