documenting traits #364
documenting traits #364
Conversation
✅ Deploy Preview for noir-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
signorecello
force-pushed
the
zpedro/traits
branch
from
05122a9
to
40c442c
Compare
There was a problem hiding this comment.
I think this documentation is rather lacking in terms of showing use cases that traits are useful for, explaining why you'd want a trait, etc. I could see some of it confusing users as well, such as the part of needing to define a struct first to implement a trait on. While this is usually the case, it isn't needed if you're implementing your own trait on an existing type. I think we should start from a usecase of when traits are needed eg. providing functionality on generic types "any type T that has an equality function," and work from there.
I'm also blocking this at the moment since I think we should avoid documenting traits until they're fully implemented and working in Noir. A note that they're being worked on right now is good but I don't want to have users seeing them in the documentation and trying to use them before they're ready.
|
Thanks @signorecello! Apologies on forgetting to update the doc issue. Let's skip this for v0.10.5 and leave this open for further follow up until we're closer to completing majority of the tasks listed in noir-lang/noir#2568 🙌 |
|
converting to draft while we figure it out |
|
closing, as #395 supersedes it |
closes noir-lang/noir#3193