Skip to content

Commit 555649c

Browse files
authored
Update some docs from 2021-10 date triage (rust-lang#1224)
1 parent 624f0bd commit 555649c

File tree

3 files changed

+11
-15
lines changed

3 files changed

+11
-15
lines changed

src/doc/rustc-dev-guide/src/backend/backend-agnostic.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<!-- toc -->
44

5-
As of <!-- date: 2021-01 --> January 2021, `rustc_codegen_ssa` provides an
5+
As of <!-- date: 2021-10 --> October 2021, `rustc_codegen_ssa` provides an
66
abstract interface for all backends to implement, to allow other codegen
77
backends (e.g. [Cranelift]).
88

src/doc/rustc-dev-guide/src/contributing.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -424,12 +424,12 @@ Just a few things to keep in mind:
424424
Try to format the date as `<MONTH> <YEAR>` to ease search.
425425

426426
- Additionally, include a machine-readable comment of the form `<!-- date:
427-
2021-01 -->` (if the current month is January 2021). We have an automated
427+
2021-10 -->` (if the current month is October 2021). We have an automated
428428
tool that uses these (in `ci/date-check`).
429429

430430
So, for the month of January 2021, the comment would look like: `As of <!--
431-
date: 2021-01 --> January 2021`. Make sure to put the comment *between* `as of`
432-
and `January 2021`; see [PR #1066][rdg#1066] for the rationale.
431+
date: 2021-10 --> October 2021`. Make sure to put the comment *between* `as of`
432+
and `October 2021`; see [PR #1066][rdg#1066] for the rationale.
433433

434434
- A link to a relevant WG, tracking issue, `rustc` rustdoc page, or similar, that may provide
435435
further explanation for the change process or a way to verify that the information is not

src/doc/rustc-dev-guide/src/rustdoc-internals.md

+7-11
Original file line numberDiff line numberDiff line change
@@ -71,29 +71,25 @@ Here is the list of passes as of <!-- date: 2021-02 --> February 2021:
7171
- `calculate-doc-coverage` calculates information used for the `--show-coverage`
7272
flag.
7373

74+
- `check-bare-urls` detects links that are not linkified, e.g., in Markdown such as
75+
`Go to https://example.com/.` It suggests wrapping the link with angle brackets:
76+
`Go to <https://example.com/>.` to linkify it. This is the code behind the
77+
<!-- date: 2021-10 --> `rustdoc::bare_urls` lint.
78+
7479
- `check-code-block-syntax` validates syntax inside Rust code blocks
7580
(<code>```rust</code>)
7681

82+
- `check-doc-test-visibility` runs doctest visibility–related lints.
83+
7784
- `check-invalid-html-tags` detects invalid HTML (like an unclosed `<span>`)
7885
in doc comments.
7986

80-
- `check-non-autolinks` detects links that could or should be written using
81-
angle brackets (the code behind the nightly-only <!-- date: 2021-02 --> `non_autolinks`
82-
lint).
83-
84-
- `collapse-docs` concatenates all document attributes into one document
85-
attribute. This is necessary because each line of a doc comment is given as a
86-
separate doc attribute, and this will combine them into a single string with
87-
line breaks between each attribute.
88-
8987
- `collect-intra-doc-links` resolves [intra-doc links](https://doc.rust-lang.org/rustdoc/linking-to-items-by-name.html).
9088

9189
- `collect-trait-impls` collects trait impls for each item in the crate. For
9290
example, if we define a struct that implements a trait, this pass will note
9391
that the struct implements that trait.
9492

95-
- `doc-test-lints` runs various lints on the doctests.
96-
9793
- `propagate-doc-cfg` propagates `#[doc(cfg(...))]` to child items.
9894

9995
- `strip-priv-imports` strips all private import statements (`use`, `extern

0 commit comments

Comments
 (0)