[doc] Render toolchain version detection in rustdoc #1944
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This PR generates rustdoc output like: 
|
2934c82 to
8dbd38a
Compare
Previously, we had avoided doing this because there wasn't any way to guarantee that we didn't make mistakes and render the wrong version for a particular named toolchain version. In this commit, we take the pragmatic approach of renaming the named toolchain versions - in particular, we add a suffix which includes the toolchain version. This is fairly error-resistant for two reasons: - At the definition site (in `Cargo.toml`), the name appears on the same line as the version, so mistakes should be obvious - At the use site (in various `.rs` files), the name appears within a few lines of any `#[cfg_attr(doc_cfg, doc(cfg(...)))]` attribute, so mistakes should similarly be obvious Release 0.8.7. Closes #894 gherrit-pr-id: I74b8e9be0e6cb6e02552d2e1f985b490a7d37afe
8dbd38a to
e435ee7
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## v0.8.x #1944 +/- ##
=======================================
Coverage 87.59% 87.59%
=======================================
Files 16 16
Lines 5988 5988
=======================================
Hits 5245 5245
Misses 743 743 ☔ View full report in Codecov by Sentry. |
jswrenn
approved these changes
Oct 21, 2024
Closed
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, we had avoided doing this because there wasn't any way to guarantee that we didn't make mistakes and render the wrong version for a particular named toolchain version.
In this commit, we take the pragmatic approach of renaming the named toolchain versions - in particular, we add a suffix which includes the toolchain version. This is fairly error-resistant for two reasons:
Cargo.toml), the name appears on the same line as the version, so mistakes should be obvious.rsfiles), the name appears within a few lines of any#[cfg_attr(doc_cfg, doc(cfg(...)))]attribute, so mistakes should similarly be obviousRelease 0.8.7.
Closes #894