Fix rustdoc #518
Fix rustdoc #518
Conversation
Adds a CI step to run `cargo doc` for all features and private items going forward which will require all users to keep their rustdoc clean. For the parts of the docs I cleaned up, I tried to put more code references in an inline code fence--this is required for types with `<` or `>`, but also the style I think we should use. I did not go through all the code to clean this up.
This is needed to get Rustdoc installed.
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## main #518 +/- ##
==========================================
- Coverage 88.90% 88.90% -0.01%
==========================================
Files 81 81
Lines 12885 12885
==========================================
- Hits 11456 11455 -1
- Misses 1429 1430 +1
... and 1 file with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
| @@ -1,5 +1,6 @@ | |||
| #![allow(dead_code)] | |||
| #![deny(rustdoc::broken_intra_doc_links)] | |||
| #![deny(rustdoc::bare_urls)] | |||
There was a problem hiding this comment.
I've seen bare URL fixes elsewhere in this patch, but without accompanying additions of this linting directive.
From my reading just now I see that bare_urls is warn-by-default, so this makes me wonder what distinction we're drawing here.
There was a problem hiding this comment.
This is saying Rustdoc will error when we make this mistake.
| @@ -34,14 +34,14 @@ impl RawSymbolToken { | |||
| } | |||
| } | |||
|
|
|||
| /// Constructs an [`OwnedSymbolToken`] with unknown text and a local ID. | |||
| /// Constructs a [`RawSymbolToken`] with unknown text and a local ID. | |||
Co-authored-by: Joshua Barr <[email protected]>
Cleans up doc comments such that
cargo doc --document-private-items --all-featuresworks and is in CI.Fixes #516
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.