Skip to content

doc: BigInt::ToWords docs not consistent with implementation #748

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mhdawson merged 1 commit into from
Jun 24, 2020
Merged

doc: BigInt::ToWords docs not consistent with implementation #748

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/bigint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Returns the number of words needed to store this `BigInt` value.
### ToWords

```cpp
void Napi::BigInt::ToWords(size_t* word_count, int* sign_bit, uint64_t* words);
void Napi::BigInt::ToWords(int* sign_bit, size_t* word_count, uint64_t* words);
```

- `[out] sign_bit`: Integer representing if the JavaScript `BigInt` is positive
Expand Down