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.

Sign up for GitHub

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

Jump to bottom

Public contract items should appear in rustdoc #336

Open
athei opened this issue Mar 2, 2020 · 0 comments
Open

Public contract items should appear in rustdoc #336

athei opened this issue Mar 2, 2020 · 0 comments
Labels
A-ink_lang [ink_lang] Work item B-enhancement New feature or request

Comments

@athei
Copy link
Contributor

athei commented Mar 2, 2020

Currently, the public items of a contract (storage items, constructor, messages) dot not appear in the rustdoc because the contract macro puts them in a private module. Only the crate level documentation is visible.

They should appear in rustdoc as a public API to the contract.
@Robbepop Robbepop mentioned this issue Mar 21, 2020
Closed
@Robbepop Robbepop added A-ink_lang [ink_lang] Work item B-enhancement New feature or request labels May 23, 2020
@cmichi cmichi self-assigned this Dec 15, 2020
@cmichi cmichi mentioned this issue Dec 15, 2020
Closed
@cmichi cmichi removed their assignment Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-ink_lang [ink_lang] Work item B-enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Make contract docs visible to rustdoc use-ink/ink
3 participants
@cmichi @athei @Robbepop