@@ -316,9 +316,8 @@ There are issues for beginners and advanced compiler devs alike!
316
316
317
317
Just a few things to keep in mind:
318
318
319
- - Please try to avoid overly long lines and use semantic line breaks (so break the line after a sentence).
320
- There is no strict limit on line lengths, let the sentence or part of the sentence flow to its proper end on the same line.
321
- There is currently nothing stopping anyone from creating overly long lines, just do your best to avoid them.
319
+ - Please try to avoid overly long lines and use semantic line breaks (where you break the line after each sentence).
320
+ There is no strict limit on line lengths; let the sentence or part of the sentence flow to its proper end on the same line.
322
321
323
322
- When contributing text to the guide, please contextualize the information with some time period
324
323
and/or a reason so that the reader knows how much to trust or mistrust the information.
@@ -336,35 +335,37 @@ Just a few things to keep in mind:
336
335
- january 2021
337
336
338
337
There is a CI action (in ` ~/.github/workflows/date-check.yml ` )
339
- that generates a monthly issue with any of these that are over 6 months old.
338
+ that generates a monthly showing those that are over 6 months old
339
+ ([ example] ( https://github.com/rust-lang/rustc-dev-guide/issues/2052 ) ).
340
340
341
341
For the action to pick the date,
342
342
add a special annotation before specifying the date:
343
343
344
344
``` md
345
- <!-- date-check --> Jan 2023
345
+ <!-- date-check --> Sep 2024
346
346
```
347
347
348
348
Example:
349
349
350
350
```md
351
- As of <!-- date-check --> Jan 2023 , the foo did the bar.
351
+ As of <!-- date-check --> Sep 2024 , the foo did the bar.
352
352
```
353
353
354
354
For cases where the date should not be part of the visible rendered output,
355
355
use the following instead:
356
356
357
357
```md
358
- <!-- date-check: Jan 2023 -->
358
+ <!-- date-check: Sep 2024 -->
359
359
```
360
360
361
361
- A link to a relevant WG, tracking issue, `rustc` rustdoc page, or similar, that may provide
362
362
further explanation for the change process or a way to verify that the information is not
363
363
outdated.
364
364
365
365
- If a text grows rather long (more than a few page scrolls) or complicated (more than four
366
- subsections) it might benefit from having a Table of Contents at the beginning, which you can
367
- auto-generate by including the `<!-- toc -->` marker.
366
+ subsections),
367
+ it might benefit from having a Table of Contents at the beginning,
368
+ which you can auto-generate by including the `<!-- toc -->` marker at the top.
368
369
369
370
## Issue triage
370
371
0 commit comments