Skip to content

Add doc_auto_cfg to automatically document required features for modules, types #2223

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
Closed
heaths opened this issue Feb 24, 2025 · 0 comments · Fixed by #2367
Closed

Add doc_auto_cfg to automatically document required features for modules, types #2223

heaths opened this issue Feb 24, 2025 · 0 comments · Fixed by #2367
Assignees
@heaths
Labels
Client This issue points to a problem in the data-plane of the library. Docs
Milestone
2025-04

Comments

@heaths
Copy link
Member

heaths commented Feb 24, 2025

We should consider adding #![cfg_attr(docsrs, feature(doc_auto_cfg))] to our crates so docs.rs automatically shows required features for types, similar to what you see for tokio:

Image

See the tracking issue for details.
@heaths heaths added Client This issue points to a problem in the data-plane of the library. Docs labels Feb 24, 2025
@heaths heaths added this to the 2025-04 milestone Feb 24, 2025
@github-project-automation github-project-automation bot moved this to Untriaged in Azure SDK Rust Feb 24, 2025
@heaths heaths mentioned this issue Mar 20, 2025
Open
heaths added a commit to heaths/azure-sdk-for-rust that referenced this issue Mar 20, 2025
@heaths
Document features for docs.rs
e1054dc 
Resolves Azure#2223
@heaths heaths mentioned this issue Mar 20, 2025
Merged
@heaths heaths self-assigned this Mar 20, 2025
@heaths heaths moved this from Untriaged to In Progress in Azure SDK Rust Mar 21, 2025
heaths added a commit that referenced this issue Mar 24, 2025
@heaths
Document features for docs.rs (#2367)
bfd3ee0 
Resolves #2223
@github-project-automation github-project-automation bot moved this from In Progress to Done in Azure SDK Rust Mar 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@heaths heaths

Labels
Client This issue points to a problem in the data-plane of the library. Docs
Projects
Azure SDK Rust
Status: Done
Milestone
2025-04
Development

Successfully merging a pull request may close this issue.

Document features for docs.rs heaths/azure-sdk-for-rust
1 participant
@heaths