Skip to content

Commit a59842e

Browse files
committed
improve "Documentation problem" issue template.
rustdoc has its own issue template now, mention that. swap the order of the last two sentances so it reads more like a typical if/else chain (base case listed last). adjust some labels and descriptions
1 parent 213d946 commit a59842e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

.github/ISSUE_TEMPLATE/documentation.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Documentation problem
2-
description: Create a report for a documentation problem.
2+
description: Report an issue with documentation content.
33
labels: ["A-docs"]
44
body:
55
- type: markdown
@@ -19,20 +19,20 @@ body:
1919
- [The Rustonomicon](https://github.com/rust-lang/nomicon/issues)
2020
- [The Embedded Book](https://github.com/rust-embedded/book/issues)
2121
22-
All other documentation issues should be filed here.
22+
Or, if you find an issue related to rustdoc (e.g. doctest, rustdoc UI), please use the rustdoc issue template instead.
2323
24-
Or, if you find an issue related to rustdoc (e.g. doctest, rustdoc UI), please use the bug report or blank issue template instead.
24+
All other documentation issues should be filed here.
2525
2626
- type: textarea
2727
id: location
2828
attributes:
29-
label: Location
29+
label: Location (URL)
3030
validations:
31-
required: true
31+
required: true
3232

3333
- type: textarea
3434
id: summary
3535
attributes:
3636
label: Summary
3737
validations:
38-
required: true
38+
required: true

0 commit comments

Comments
 (0)