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 entry_point in cosmwasm-std instead of derive #2245

Merged
merged 1 commit into from
Sep 9, 2024

Conversation

webmaster128
Copy link
Member

Closes #2186

Turns out we can document the re-export instead of the function definition. This also executes the doc tests as part of cosmwasm-std.

Copy link
Collaborator

@chipshort chipshort left a comment

Choose a reason for hiding this comment

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

Interesting, I tested this before and thought it didn't work because it does not show up when hovering in vscode. But it does work with cargo doc, so I think we can go with it.

@webmaster128
Copy link
Member Author

In https://doc.rust-lang.org/rustdoc/write-documentation/re-exports.html it is explained how all of this is supposed to work. I did not really understand all the cases but it seems to be well defined behaviour.

@webmaster128 webmaster128 merged commit c88d05e into main Sep 9, 2024
32 checks passed
@webmaster128 webmaster128 deleted the document-entry_point-std branch September 9, 2024 08:34
@chipshort chipshort mentioned this pull request Sep 23, 2024
@aumetra
Copy link
Member

aumetra commented Sep 24, 2024

@mergify backport release/1.5 release/2.0 release/2.1

Copy link
Contributor

mergify bot commented Sep 24, 2024

backport release/1.5 release/2.0 release/2.1

✅ Backports have been created

aumetra added a commit that referenced this pull request Sep 24, 2024
Document entry_point in cosmwasm-std instead of derive (backport #2245)
aumetra added a commit that referenced this pull request Sep 24, 2024
Document entry_point in cosmwasm-std instead of derive (backport #2245)
aumetra added a commit that referenced this pull request Sep 24, 2024
Document entry_point in cosmwasm-std instead of derive (backport #2245)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cosmwasm-std dev-dependency in cosmwasm-derive causes cargo release to fail
3 participants