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. #734

Merged
merged 3 commits into from
Nov 5, 2024
Merged

Match CI doc testing with docs.rs. #734

merged 3 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 we don't have any examples by Cargo's definition, 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.
  • Enable the doc_auto_cfg feature for docs.rs which will show a little tip next to feature gated functionality informing of the crate feature flag.

@@ -38,7 +38,7 @@ pub(crate) struct WgpuEngine {
#[cfg(not(target_arch = "wasm32"))]
shaders_to_initialise: Option<Vec<UninitialisedShader>>,
pub(crate) use_cpu: bool,
/// Overrides from a specific `Image`'s [`id`](peniko::Image::id) to a wgpu `Texture`.
/// Overrides from a specific `Image`'s [`id`](peniko::Blob::id) to a wgpu `Texture`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Feel like this might be better phrased to indicate that the id comes from the image's blob ...

@xStrom xStrom enabled auto-merge November 5, 2024 12:48
@xStrom xStrom added this pull request to the merge queue Nov 5, 2024
Merged via the queue into linebender:main with commit 64fc566 Nov 5, 2024
17 checks passed
@xStrom xStrom deleted the cidoc branch November 5, 2024 12:55
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