Skip to content

docs: replace doc_auto_cfg config with doc_cfg #1142

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

Merged
merged 5 commits into from
Oct 18, 2025
Merged

docs: replace doc_auto_cfg config with doc_cfg #1142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
85d1892
docs: replace doc_auto_cfg config with doc_cfg
tottoto Oct 2, 2025
f0d6b12
ci: enable docsrs only on rustdoc
tottoto Oct 2, 2025
f93e895
ci: Use cargo doc to detect missing documentation on building document
tottoto Oct 2, 2025
86f3ea0
ci: Remove graceful document to check
tottoto Oct 2, 2025
044c4a1
Revert "ci: Remove graceful document to check"
tottoto Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,7 @@ jobs:
- name: Install Rust
uses: dtolnay/rust-toolchain@nightly

# check for missing docs
- name: cargo check
run: cargo check --all-features
env:
RUSTFLAGS: "--cfg docsrs"
Copy link
Owner

@seanmonstar seanmonstar Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this line was important for something... There's a builder that has docs exposed but otherwise the type is unnameable, and I added this to catch that all methods were documented correctly. I think?

Copy link
Contributor Author

@tottoto tottoto Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Migrated this checking to the building document process. It could be detected as https://github.com/seanmonstar/warp/actions/runs/18195955801/job/51802257485#step:4:202.


- name: cargo doc
run: cargo rustdoc --all-features -- -D 'rustdoc::broken_intra_doc_links'
run: cargo doc --all-features --no-deps
env:
RUSTFLAGS: "--cfg docsrs"
RUSTDOCFLAGS: "--cfg docsrs -D rustdoc::broken_intra_doc_links"
2 changes: 1 addition & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#![deny(missing_debug_implementations)]
#![deny(rust_2018_idioms)]
#![cfg_attr(test, deny(warnings))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![cfg_attr(docsrs, feature(doc_cfg))]

//! # warp
//!
Expand Down