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

Fix up feature documentation with rustdoc #8

Open
dequbed opened this issue Sep 10, 2022 · 2 comments
Open

Fix up feature documentation with rustdoc #8

dequbed opened this issue Sep 10, 2022 · 2 comments
Assignees
Labels
good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed

Comments

@dequbed
Copy link
Owner

dequbed commented Sep 10, 2022

Right now the features required for mechanisms to be available is written as plain text. Rustdoc has a feature to have the fact that a certain module needs a certain feature documented in a standart format.

It would be quite nice to switch to that as soon as that stabilizes.

@dequbed dequbed added help wanted Extra attention is needed good first issue Good for newcomers labels Sep 10, 2022
@dequbed
Copy link
Owner Author

dequbed commented Sep 27, 2022

The rustdoc feature to document #[cfg(feature = "...")] is explained here: https://doc.rust-lang.org/rustdoc/unstable-features.html#doccfg-recording-what-platforms-or-features-are-required-for-code-to-be-present

Until that is implemented it's probably best to somehow selectively enable use of it using #[cfg_attr(...

@duesee
Copy link
Contributor

duesee commented Nov 21, 2023

Hey @dequbed. Could you assign me this issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants