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 in-code documentation of map primitives #443

Merged
merged 4 commits into from
Sep 21, 2021

Conversation

ueco-jb
Copy link
Contributor

@ueco-jb ueco-jb commented Sep 20, 2021

closes #407

It's not a world-breaking change, but can improve work a bit - when IDE shows suggestion about structures, it often shows Rust's doc comments as well.

@ueco-jb ueco-jb added the documentation Improvements or additions to documentation label Sep 20, 2021
@ueco-jb ueco-jb self-assigned this Sep 20, 2021
@ueco-jb ueco-jb force-pushed the 407-improve-documentation-of-map-primitives branch from c44ab36 to 330640a Compare September 20, 2021 13:55
Copy link
Member

@ethanfrey ethanfrey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice start. Some feedback

packages/storage-plus/src/snapshot/mod.rs Outdated Show resolved Hide resolved
packages/storage-plus/src/snapshot/mod.rs Outdated Show resolved Hide resolved
@ueco-jb
Copy link
Contributor Author

ueco-jb commented Sep 21, 2021

I had plenty of issues while compiling those examples I've added, but finally I've managed to keep it small and precise.

@ueco-jb ueco-jb requested a review from ethanfrey September 21, 2021 09:11
Copy link
Member

@ethanfrey ethanfrey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good and brings knowledge from test code closer to the docs.

@ethanfrey ethanfrey merged commit 83ba4d2 into main Sep 21, 2021
@ethanfrey ethanfrey deleted the 407-improve-documentation-of-map-primitives branch September 21, 2021 09:57
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.

storage-plus: Improve in-code documentation of map primitives, in particular MultiIndex
2 participants