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

Document Item #134

Merged
merged 6 commits into from
Nov 25, 2024
Merged

Document Item #134

merged 6 commits into from
Nov 25, 2024

Conversation

uint
Copy link
Contributor

@uint uint commented Aug 12, 2024

No description provided.

@uint uint added the storey label Aug 12, 2024
Copy link

vercel bot commented Aug 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
cosmwasm-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 3, 2024 2:15pm

@uint
Copy link
Contributor Author

uint commented Aug 12, 2024

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.

Copy link
Member

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

src/pages/storey/containers.mdx Outdated Show resolved Hide resolved
src/pages/storey/containers.mdx Show resolved Hide resolved
src/pages/storey/containers.mdx Show resolved Hide resolved
src/pages/storey/containers/item.mdx Outdated Show resolved Hide resolved
use cw_storey::CwStorage;

let admin: Item<String> = Item::new(0);
let mut cw_storage = CwStorage(&mut storage);
Copy link
Member

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

src/pages/storey/containers/item.mdx Outdated Show resolved Hide resolved
src/pages/storey/containers/item.mdx Show resolved Hide resolved
Copy link
Collaborator

@hashedone hashedone left a 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).

src/pages/storey/containers/item.mdx Outdated Show resolved Hide resolved
Copy link
Collaborator

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

@uint uint merged commit e361a4c into main Nov 25, 2024
6 checks passed
@uint uint deleted the storey-item branch November 25, 2024 10:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants