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

Documentation is missing feature flags #688

Open
tbu- opened this issue May 21, 2024 · 1 comment
Open

Documentation is missing feature flags #688

tbu- opened this issue May 21, 2024 · 1 comment

Comments

@tbu-
Copy link

tbu- commented May 21, 2024

In the documentation, you can't see which feature flags need to be activated for a certain function/struct/module to be available.

E.g. like you can see in zerocopy's docs that the byteorder feature is required for the byteorder module to be available.

@philipc
Copy link
Contributor

philipc commented May 23, 2024

Is there a particular item that you thought this would be helpful for? Most of the features have a simple mapping to module names.

doc_cfg and doc_auto_cfg are unstable features. doc_cfg requires manual annotation; I could add this for the top level modules if that is sufficient. doc_auto_cfg gives output like the following which is too much noise:

image

or the following which isn't giving any non-obvious information:

image

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

2 participants