Skip to content
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

Jump to bottom

Document TypeScript methods under lib/web #390

Open
cryptoquick opened this issue Oct 8, 2023 · 2 comments
Open

Document TypeScript methods under lib/web #390

cryptoquick opened this issue Oct 8, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@cryptoquick
Copy link
Member

cryptoquick commented Oct 8, 2023 •
edited
Loading

The TypeScript methods are very under-documented. It would be a huge help to us if someone wanted to add comments to functions in the various bitmask-core modules, including for example calls and example output.

This is meant to be high-level documentation and available in both Rust and TypeScript.

Reference the TypeScript files under lib/web. They're basically thin wrappers around BMC calls.
@cryptoquick cryptoquick added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Oct 8, 2023
@lastdof
Copy link

lastdof commented Nov 2, 2023

I will try ?

@cryptoquick
Copy link
Member Author

Please do!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@cryptoquick @lastdof