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

Improve Traits stdlib page in docs with user-oriented elaborations and examples #3969

Closed
Savio-Sou opened this issue Jan 5, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@Savio-Sou
Copy link
Collaborator

Savio-Sou commented Jan 5, 2024

Problem

As per #3796, the standard library - traits page was introduced in the Noir docs.

As it currently stands, it is not fully intuitive how each of the functions are useful and can be used.

Happy Case

Will defer to assignee of this issue, but one possible way could be turning the current implementation code blocks on the page into minimal examples that demonstrate usage.

Alternatives Considered

No response

Additional Context

Can refer to Rust's docs for descriptions of similar methods.

Would you like to submit a PR for this Issue?

No

Support Needs

No response

@Savio-Sou Savio-Sou added enhancement New feature or request documentation Improvements or additions to documentation labels Jan 5, 2024
@Savio-Sou Savio-Sou added this to the 0.21.0 milestone Jan 5, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Noir Jan 5, 2024
@Savio-Sou Savio-Sou changed the title Update Traits stdlib page in docs with user-oriented elaborations and examples Improve Traits stdlib page in docs with user-oriented elaborations and examples Jan 5, 2024
@Savio-Sou
Copy link
Collaborator Author

@signorecello would you like to pair with @jfecher and work on this?

Albeit we are holding off from actively promoting Traits publicly with v0.21.0, we should have all changes in the version properly documented before announcing the release.

@signorecello
Copy link
Contributor

Hey indeed I wouldn't block any release with this. @jfecher has done some AMAZING work so far, and better examples will come later when I have the time to get up to speed and add some real use-case examples in a how-to guide or something

@Savio-Sou
Copy link
Collaborator Author

Savio-Sou commented Jan 8, 2024

Note that this is for the standard library - traits page, not the types - traits page (which was beautifully written).

Fine to consider this non-blocking as long as the anticipated risk of support resource drain is sufficiently low 🙌

@Savio-Sou Savio-Sou removed the enhancement New feature or request label Jan 23, 2024
@TomAFrench TomAFrench closed this as not planned Won't fix, can't repro, duplicate, stale Apr 20, 2024
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Noir Apr 20, 2024
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
Archived in project
Development

No branches or pull requests

3 participants