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

Match CI doc testing with docs.rs. #397

Merged
merged 2 commits into from
Nov 5, 2024
Merged

Match CI doc testing with docs.rs. #397

merged 2 commits into from
Nov 5, 2024

Conversation

xStrom
Copy link
Member

@xStrom xStrom commented Nov 5, 2024

  • Remove -Zunstable-options -Zrustdoc-scrape-examples from CI. It wasn't even enabled for docs.rs and the examples we have lead to more noise than anything in the docs, so not worth enabling scraping at this point.
  • Treat doc warnings as errors. Historically we've not done so due to various rustdoc bugs giving false positives but I got it to pass without failure right now, so perhaps better times have arrived.
  • Pass --all-features at docs.rs to match our CI and reduce the maintenance burden of manually syncing the features list.
  • Target only x86_64-unknown-linux-gnu on docs.rs as we don't have any platform specific docs.

Copy link
Contributor

@waywardmonkeys waywardmonkeys left a comment

Choose a reason for hiding this comment

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

You snuck a typos update in as well!

For other repos, if you look into doing the same, also need to make sure they correctly enable #![cfg_attr(docsrs, feature(doc_auto_cfg))] like this crate does (if appropriate).

@xStrom xStrom added this pull request to the merge queue Nov 5, 2024
Merged via the queue into linebender:main with commit a44f3b6 Nov 5, 2024
15 checks passed
@xStrom xStrom deleted the cidoc branch November 5, 2024 10:26
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

Successfully merging this pull request may close these issues.

2 participants