-
Notifications
You must be signed in to change notification settings - Fork 522
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
Update some docs from 2021-10 date triage #1224
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -71,29 +71,25 @@ Here is the list of passes as of <!-- date: 2021-02 --> February 2021: | |
- `calculate-doc-coverage` calculates information used for the `--show-coverage` | ||
flag. | ||
|
||
- `check-bare-urls` detects links that are not linkified, e.g., in Markdown such as | ||
`Go to https://example.com/.` It suggests wrapping the link with angle brackets: | ||
`Go to <https://example.com/>.` to linkify it. This is the code behind the | ||
<!-- date: 2021-10 --> `rustdoc::bare_urls` lint. | ||
|
||
- `check-code-block-syntax` validates syntax inside Rust code blocks | ||
(<code>```rust</code>) | ||
|
||
- `check-doc-test-visibility` runs doctest visibility–related lints. | ||
|
||
- `check-invalid-html-tags` detects invalid HTML (like an unclosed `<span>`) | ||
in doc comments. | ||
|
||
- `check-non-autolinks` detects links that could or should be written using | ||
angle brackets (the code behind the nightly-only <!-- date: 2021-02 --> `non_autolinks` | ||
lint). | ||
|
||
- `collapse-docs` concatenates all document attributes into one document | ||
attribute. This is necessary because each line of a doc comment is given as a | ||
separate doc attribute, and this will combine them into a single string with | ||
line breaks between each attribute. | ||
Comment on lines
-84
to
-87
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This pass did almost nothing and was removed in December. |
||
|
||
- `collect-intra-doc-links` resolves [intra-doc links](https://doc.rust-lang.org/rustdoc/linking-to-items-by-name.html). | ||
|
||
- `collect-trait-impls` collects trait impls for each item in the crate. For | ||
example, if we define a struct that implements a trait, this pass will note | ||
that the struct implements that trait. | ||
|
||
- `doc-test-lints` runs various lints on the doctests. | ||
|
||
- `propagate-doc-cfg` propagates `#[doc(cfg(...))]` to child items. | ||
|
||
- `strip-priv-imports` strips all private import statements (`use`, `extern | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems to still be true, and it seems unlikely that it'll change.