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.

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

Merged
merged 9 commits into from
Feb 8, 2024
Merged

chore: document noir_wasm #4213

merged 9 commits into from
Feb 8, 2024

Conversation

Thunkar
Copy link
Contributor

@Thunkar Thunkar commented Jan 31, 2024

Problem

Resolves #4137

Summary

Added using typedoc, better comments and improved readme.

Check one:

  • No documentation needed.
  • Documentation included in this PR.
  • [Exceptional Case] Documentation to be submitted in a separate PR.

PR Checklist*

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 31, 2024
@Thunkar Thunkar requested a review from a team January 31, 2024 08:41
@Thunkar Thunkar self-assigned this Jan 31, 2024
Copy link
Contributor

github-actions bot commented Jan 31, 2024

@Thunkar Thunkar marked this pull request as ready for review January 31, 2024 14:07
@signorecello
Copy link
Contributor

signorecello commented Feb 1, 2024

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

Copy link
Contributor

@signorecello signorecello left a 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

Copy link
Contributor

@signorecello signorecello left a 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

@Thunkar
Copy link
Contributor Author

Thunkar commented Feb 2, 2024

@signorecello not sure what you mean by "same formatting", sorry...

I think the only difference is that I added the README.md on the "front page" to slightly document usage?. From what I see, types and functions use the same formatting, the only potential problem I see is that we export CompilationResult as a union type, but the members of said union are not exported and therefore not documented.

Please let me know, I would like to improve this!

Copy link
Contributor

@signorecello signorecello left a 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!

@signorecello signorecello added this pull request to the merge queue Feb 8, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Feb 8, 2024
@Thunkar Thunkar added this pull request to the merge queue Feb 8, 2024
Merged via the queue into master with commit ba25a97 Feb 8, 2024
33 checks passed
@Thunkar Thunkar deleted the gj/noir_wasm_docs branch February 8, 2024 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document noir_wasm
2 participants