add issue template for rustdoc #142736
add issue template for rustdoc #142736
Conversation
|
|
rustbot
added
A-meta
lolbinarycat
added
the
T-rustdoc
lolbinarycat
force-pushed
the
rustdoc-issue-template
branch
from
b6920da to
dfaa622
Compare
|
Seems good to me, thanks! Gonna let @fmease give the final approval. |
|
Thanks for your understanding and for incorporating my feedback! @bors r=GuillaumeGomez,fmease |
bors
added
S-waiting-on-bors
|
@bors rollup |
| --> | ||
|
|
||
| # Code | ||
| <!-- problematic snippet and/or link to repo and/or full path of standard library function --> |
There was a problem hiding this comment.
I think it's worth trying to encourage people to submit self-contained bugs, rather than point to std.
Obviously it's not always possible, but when it is, I think it's valuable to get an example than can be build locally.
|
|
||
| # Version | ||
| <!-- | ||
| Available via `rustdoc --version` or under the "Help" menu. |
There was a problem hiding this comment.
NIT: rustdoc --version --verbose is worthwhile.
There was a problem hiding this comment.
for what info? the only extra info it really adds as far as I can see are LLVM version and host platform triple, which I haven't seen be relevant ever (am I missing something?)
There was a problem hiding this comment.
I was mainly thinking commit hash, but checking it now that's also in plain rustdoc -V output, so I think this is fine.
This also expands the scope of the "diagnosticissue" 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.
r? t-rustdoc