-
Notifications
You must be signed in to change notification settings - Fork 4
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
Document Item
#134
Document Item
#134
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Also added a missing bit of info about the "accessors". I don't think it's important to go deep into that, but users are bound to notice they're going through that weird thing when interacting with storage. |
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.
Some thoughts coming to mind, but strictly speaking about the API not the docs
use cw_storey::CwStorage; | ||
|
||
let admin: Item<String> = Item::new(0); | ||
let mut cw_storage = CwStorage(&mut storage); |
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.
Mentioned above already, but it would really be great if we could avoid that for every single storage access
Co-authored-by: Simon Warta <[email protected]>
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.
I find this docs highly incomplete. There are usage examples, but every single example should be prefixed with some foreword on what problem we discuss, and afterword explaining what happens in the key lines. Also key lines should be highlighted (we have API for this, check sylvia docs I believe - it was used there).
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.
Most comments are about changes in library itself, but for documentatation it LGTM
No description provided.