-
Notifications
You must be signed in to change notification settings - Fork 199
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.
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
chore: document noir_wasm #4213
Conversation
🚀 Deployed on https://65c4a18877850200a56abdd5--noir-docs.netlify.app |
Probably at this point you feel the Typedoc pain. It's a particular pain, it hits all the head homogeneously, with great intensity. But... I'd like it to look like the other packages, which should be achievable by replicating the way they're documented. I can pick this up if you need it, my head already stopped hurting from the Typedoc pain from a few months ago |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs a bit more work to achieve the same formatting as the other two JS packages
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs a bit more work to achieve the same formatting as the other two JS packages
@signorecello not sure what you mean by "same formatting", sorry... I think the only difference is that I added the Please let me know, I would like to improve this! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great now! Thank you!
Problem
Resolves #4137
Summary
Added using typedoc, better comments and improved readme.
Check one:
PR Checklist*
cargo fmt
on default settings.