Skip to content

Commit b6920da

Browse files
committed
add issue template for rustdoc
This also expands the scope of the "diagnostic issue" template to include rustdoc lints, meaning diagnostic issues will need triaging again. I think this is preferable to the alternative of cramming even more cases under a single issue template.
1 parent 3bc767e commit b6920da

File tree

3 files changed

+59
-6
lines changed

3 files changed

+59
-6
lines changed

.github/ISSUE_TEMPLATE/diagnostics.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Diagnostic issue
2-
description: Create a bug report or feature request for a change to `rustc`'s error output
3-
labels: ["A-diagnostics", "T-compiler"]
2+
description: Create a bug report or feature request for a change to `rustc`' or `rustdoc`'s error output or lints
3+
labels: ["A-diagnostics"]
44
body:
55
- type: markdown
66
attributes:
@@ -23,8 +23,8 @@ body:
2323
id: output
2424
attributes:
2525
label: Current output
26-
description: Please provide the `rustc` output you see
27-
placeholder: rustc output
26+
description: Please provide the console output you see
27+
placeholder: rustc/rustdoc output
2828
render: Shell
2929
validations:
3030
required: true
@@ -75,4 +75,4 @@ body:
7575
label: Anything else?
7676
description: If you have more details you want to give us to reproduce this issue, please add it here
7777
validations:
78-
required: false
78+
required: false

.github/ISSUE_TEMPLATE/rustdoc.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
name: Problem with rustdoc
3+
about: Report an issue with how docs get generated.
4+
labels: C-bug, T-rustdoc
5+
---
6+
<!--
7+
Thank you for filing a rustdoc issue! Rustdoc is the tool that handles the generation of docs. It is usually invoked via `cargo doc`, but can also be used directly.
8+
9+
If you have an issue with the actual content of the docs, use the "Documentation problem" template instead.
10+
11+
If you have an issue with a lint or error message, use the "Diagnostic issue" template instead.
12+
-->
13+
14+
# Code
15+
<!-- problematic snippet and/or link to repo and/or full path of standard library function -->
16+
17+
```rust
18+
<code>
19+
```
20+
21+
# Reproduction Steps
22+
<!--
23+
* command(s) to run, if any
24+
* permalink to hosted documentation, if any
25+
* search query, if any
26+
-->
27+
28+
# Expected Outcome
29+
<!--
30+
What did you want to happen?
31+
32+
For GUI changes, feel free to provide a mockup image of what you want it to look like.
33+
-->
34+
35+
# Actual Output
36+
<!--
37+
* rustdoc console output
38+
* browser screenshot of generated html
39+
* rustdoc json (prettify by running through `jq` or running thorugh an online formatter)
40+
-->
41+
```console
42+
<code>
43+
```
44+
45+
46+
# Version
47+
<!--
48+
Available via `rustdoc --version` or under the "Help" menu.
49+
50+
If the issue involves opening the documentation in a browser, please also provide the name and version of the browser used.
51+
-->
52+
53+
# Additional Details
54+
<!-- Anything else you think is relevant -->

triagebot.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -524,7 +524,6 @@ new_pr = true
524524
new_issue = true
525525
exclude_labels = [
526526
"C-tracking-issue",
527-
"A-diagnostics",
528527
]
529528

530529
[autolabel."WG-trait-system-refactor"]

0 commit comments

Comments
 (0)