Skip to content

Commit 5297659

Browse files
authored
Fix date-check comment formatting (#1066)
I realized that the format I had been previously using for date-checks (as of January 2021 <!-- date: 2021-01 -->) left a space before the closing parenthesis in the rendered output, which looks weird. I could fix this by removing the space between `2021` and `<!-- ...`, but that looks weird in the source. So I ended up deciding on changing it to (as of <!-- date: 2021-01 --> January 2021)
1 parent f5eea60 commit 5297659

File tree

7 files changed

+10
-10
lines changed

7 files changed

+10
-10
lines changed

src/diagnostics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -596,7 +596,7 @@ declare_lint! {
596596

597597
If you need a combination of options that's not supported by the `declare_lint!`
598598
macro, you can always define your own static with a type of `&Lint` but this is
599-
(as of January 2021 <!-- date: 2021-01 -->) linted against in the compiler tree.
599+
(as of <!-- date: 2021-01 --> January 2021) linted against in the compiler tree.
600600

601601
<a id="future-incompatible"></a>
602602
#### Guidelines for creating a future incompatibility lint

src/git.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ no changes added to commit (use "git add" and/or "git commit -a")
147147
These changes are not changes to files: they are changes to submodules (more on
148148
this [later](#git-submodules)). To get rid of those, run `git submodule update`
149149
(or run any `x.py` command, which will automatically update the submodules).
150-
Note that there is (as of January 2021 <!-- date: 2021-01 -->) a bug if you use
150+
Note that there is (as of <!-- date: 2021-01 --> January 2021) a bug if you use
151151
worktrees, submodules, and x.py in a commit hook. If you run into an error
152152
like:
153153

src/llvm-coverage-instrumentation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -221,8 +221,8 @@ properly-configured variables in LLVM IR, according to very specific
221221
details of the [_LLVM Coverage Mapping Format_][coverage-mapping-format]
222222
(Version 4).[^llvm-and-covmap-versions]
223223

224-
[^llvm-and-covmap-versions]: The Rust compiler (as of January 2021 <!-- date:
225-
2021-01 -->) supports _LLVM Coverage Mapping Format_ Version 4 (the most
224+
[^llvm-and-covmap-versions]: The Rust compiler (as of <!-- date: 2021-01 -->
225+
January 2021) supports _LLVM Coverage Mapping Format_ Version 4 (the most
226226
up-to-date version of the format, at the time of this writing) for improved
227227
compatibility with other LLVM-based compilers (like _Clang_), and to take
228228
advantage of some format optimizations. Version 4 was introduced in _LLVM 11_,

src/opaque-types-type-alias-impl-trait.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ This declares an opaque type named `Foo`, of which the only information is that
1414
it implements `Bar`. Therefore, any of `Bar`'s interface can be used on a `Foo`,
1515
but nothing else (regardless of whether it implements any other traits).
1616

17-
Since there needs to be a concrete background type, you can (as of January 2021
18-
<!-- date: 2021-01 -->) express that type by using the opaque type in a
17+
Since there needs to be a concrete background type, you can (as of <!-- date:
18+
2021-01 --> January 2021) express that type by using the opaque type in a
1919
"defining use site".
2020

2121
```rust,ignore

src/query.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Queries: demand-driven compilation
22

33
As described in [the high-level overview of the compiler][hl], the Rust compiler
4-
is still (as of January 2021 <!-- date: 2021-01 -->) transitioning from a
4+
is still (as of <!-- date: 2021-01 --> January 2021) transitioning from a
55
traditional "pass-based" setup to a "demand-driven" system. **The Compiler Query
66
System is the key to our new demand-driven organization.** The idea is pretty
77
simple. You have various queries that compute things about the input – for

src/traits/chalk.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Chalk-based trait solving
22

3-
[Chalk][chalk] is an experimental trait solver for Rust that is (as of January
4-
2021 <!-- date: 2021-01 -->) under development by the [Traits Working
3+
[Chalk][chalk] is an experimental trait solver for Rust that is (as of <!--
4+
date: 2021-01 --> January 2021) under development by the [Traits Working
55
Group][wg]. Its goal is to enable a lot of trait system features and bug fixes
66
that are hard to implement (e.g. GATs or specialization). If you would like to
77
help in hacking on the new solver, you will find instructions for getting

src/type-inference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ inference works, or perhaps this blog post on
7272
[Unification in the Chalk project]: http://smallcultfollowing.com/babysteps/blog/2017/03/25/unification-in-chalk-part-1/
7373

7474
All told, the inference context stores four kinds of inference variables (as of
75-
January 2018 <!-- date: 2018-01 -->):
75+
<!-- date: 2018-01 --> January 2018):
7676

7777
- Type variables, which come in three varieties:
7878
- General type variables (the most common). These can be unified with any

0 commit comments

Comments
 (0)