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

fix: add doc_cfg to improve docs.rs experience #7

Open
t3hmrman opened this issue Jul 28, 2023 · 1 comment · Fixed by #8
Open

fix: add doc_cfg to improve docs.rs experience #7

t3hmrman opened this issue Jul 28, 2023 · 1 comment · Fixed by #8
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@t3hmrman
Copy link
Owner

See comment in users.rust-lang.org -- on docs.rs it's very hard to tell where the tokio package comes from (the feature is required) -- so it's a good idea to use the recommended doc_cfg flag.

Thanks SkiFire13 for the recommendation
@t3hmrman t3hmrman added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 28, 2023
@t3hmrman t3hmrman mentioned this issue Jul 28, 2023
Merged
@t3hmrman
Copy link
Owner Author

Re-opening since the current documentation for runtime::tokio::wait_for still doesn't show the feature flag requirement

@t3hmrman t3hmrman reopened this Jul 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(docs): add doc_cfg for feature-specific items t3hmrman/situwaition
1 participant
@t3hmrman