-
Notifications
You must be signed in to change notification settings - Fork 13.6k
improve "Documentation problem" issue template. #145130
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.
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
base: master
Are you sure you want to change the base?
improve "Documentation problem" issue template. #145130
Conversation
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).
rustbot has assigned @Mark-Simulacrum. Use |
Or, if you find an issue related to rustdoc (e.g. doctest, rustdoc UI), please use the bug report or blank issue template instead. | ||
All other documentation issues should be filed here. | ||
- type: textarea | ||
id: location | ||
attributes: | ||
label: Location |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Location(URL)
may be more pointedly?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good, I think with the two suggestions we can make it even better. r=me with or without the suggestions
@@ -1,5 +1,5 @@ | |||
name: Documentation problem | |||
description: Create a report for a documentation problem. | |||
description: Create a report for an issue with documentation content. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
description: Create a report for an issue with documentation content. | |
description: Report an issue with documentation content. |
nit
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).