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

Update some docs from 2021-10 date triage #1224

Merged
merged 1 commit into from
Oct 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/backend/backend-agnostic.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<!-- toc -->

As of <!-- date: 2021-01 --> January 2021, `rustc_codegen_ssa` provides an
As of <!-- date: 2021-10 --> October 2021, `rustc_codegen_ssa` provides an
abstract interface for all backends to implement, to allow other codegen
backends (e.g. [Cranelift]).
Comment on lines -5 to 7
Copy link
Member Author

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.


Expand Down
6 changes: 3 additions & 3 deletions src/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -424,12 +424,12 @@ Just a few things to keep in mind:
Try to format the date as `<MONTH> <YEAR>` to ease search.

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

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

- A link to a relevant WG, tracking issue, `rustc` rustdoc page, or similar, that may provide
further explanation for the change process or a way to verify that the information is not
Expand Down
18 changes: 7 additions & 11 deletions src/rustdoc-internals.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member Author

Choose a reason for hiding this comment

The 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
Expand Down