Skip to content

Commit 2bbbb79

Browse files
committed
Fixes rust-lang#924 Addressed comments
1 parent 8d61c21 commit 2bbbb79

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

src/about-this-guide.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ If you find any mistakes in the guide, please file an issue about it, or even be
4545
a correction!
4646

4747
If you do contribute to the guide, please see the corresponding
48-
[subsection on writing documentation in this guide](contributing.md#contributing-to-rustc-dev-guide).
48+
[subsection on writing documentation in this guide].
49+
50+
[subsection on writing documentation in this guide]: contributing.md#contributing-to-rustc-dev-guide.
4951

5052
> “‘All conditioned things are impermanent’ — when one sees this with wisdom, one turns away from
5153
> suffering.” _The Dhammapada, verse 277_

src/contributing.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -403,11 +403,10 @@ The CSS might be messed up, but you can verify that the HTML is right.
403403

404404
### Contributing to rustc-dev-guide
405405

406-
Additionally, contributions to the [rustc-dev-guide][rdg] are always welcome.
407-
Contributions can be made directly at [the rust-lang/rustc-dev-guide
408-
repo][rdgrepo]. The issue tracker in that repo is also a great way to find
409-
things that need doing. There are issues for beginners and advanced compiler
410-
devs alike!
406+
Contributions to the [rustc-dev-guide][rdg] are always welcome, and can be made directly at
407+
[the rust-lang/rustc-dev-guide repo][rdgrepo].
408+
The issue tracker in that repo is also a great way to find things that need doing.
409+
There are issues for beginners and advanced compiler devs alike!
411410

412411
Just a few things to keep in mind:
413412

@@ -417,8 +416,8 @@ Just a few things to keep in mind:
417416
Aim to provide a reasonable amount of context, possibly including but not limited to:
418417
- A reason for why the data may be out of date other than "change", as change is a constant across
419418
the project.
420-
- A date the comment was added, e.g. instead of writing _"Currently, ..."_, or
421-
_"In the future, ..."_, consider writing _"As of January 2021, ..."_.
419+
- A date the comment was added, e.g. instead of writing _"Currently, ..."_ consider writing
420+
_"As of January 2021, ..."_.
422421
Try to format the date as `<MONTH> <YEAR>` to ease search.
423422
- A link to a relevant WG, tracking issue, `rustc` rustdoc page, or similar, that may provide
424423
further explanation for the change process or a way to verify that the information is not

0 commit comments

Comments
 (0)