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

Docsrs API documentation fails to display feature-gated items #48

Open
pezcore opened this issue Mar 11, 2023 · 0 comments
Open

Docsrs API documentation fails to display feature-gated items #48

pezcore opened this issue Mar 11, 2023 · 0 comments

Comments

@pezcore
Copy link
Contributor

pezcore commented Mar 11, 2023

For example: Mnemonic::generate, Mnemonic::generate_in and Mnemonic::generate_in_with are completely omitted from the API documentation, and there is no mention of the features that enable them:
2023-03-11-135525_1008x1143_scrot

From the API documentation alone, one would have no idea that this functionality exists or how to use it.

Instead, these feature gated items should appear in the API documentation along with a marker that identifies them as being available only with certain crate features enabled. Here is an example of how it should look taken from the k256 crate:
2023-03-11-140233_541x184_scrot
.

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

No branches or pull requests

1 participant