Skip to content

add issue template for rustdoc #142736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+54 −0
Open

add issue template for rustdoc #142736

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/rustdoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
name: Problem with rustdoc
about: Report an issue with how docs get generated.
labels: C-bug, T-rustdoc
---
<!--
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.

If you have an issue with the actual content of the docs, use the "Documentation problem" template instead.
-->

# Code
<!-- problematic snippet and/or link to repo and/or full path of standard library function -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


```rust
<code>
```

# Reproduction Steps
<!--
* command(s) to run, if any
* permalink to hosted documentation, if any
* search query, if any
-->

# Expected Outcome
<!--
What did you want to happen?

For GUI issues, feel free to provide a mockup image of what you want it to look like.

For diagnostics, please provide a mockup of the desired output in a code block.
-->

# Actual Output
<!--
* rustdoc console output
* browser screenshot of generated html
* rustdoc json (prettify by running through `jq` or running thorugh an online formatter)
-->
```console
<code>
```


# Version
<!--
Available via `rustdoc --version` or under the "Help" menu.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NIT: rustdoc --version --verbose is worthwhile.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was mainly thinking commit hash, but checking it now that's also in plain rustdoc -V output, so I think this is fine.


If the issue involves opening the documentation in a browser, please also provide the name and version of the browser used.
-->

# Additional Details
<!-- Anything else you think is relevant -->
Loading