Skip to content

Improve "rustdoc.md" issue template #145143

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

xizheyin
Copy link
Member

@xizheyin xizheyin commented Aug 9, 2025

I rename the title of rustdoc.md to Problem with rustdoc tool, which is clearer.

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 9, 2025
@jieyouxu
Copy link
Member

jieyouxu commented Aug 9, 2025

I can't tell how the changed wording is actually different from the existing wording?

I don't really have strong opinions on this.
r? @apiraino (or reroll)

@rustbot rustbot assigned apiraino and unassigned jieyouxu Aug 9, 2025
@joshtriplett
Copy link
Member

The text change here doesn't seem like an improvement, and I'm not sure what connection it has to the description of this PR. "bug reports or feature requests, which may be confused with feature requests"?

I don't think this change should be merged in its current form.

@xizheyin
Copy link
Member Author

xizheyin commented Aug 9, 2025

https://rust-lang.zulipchat.com/#narrow/channel/242269-t-release.2Ftriage/topic/Issue.20templates

Both diagnostic.yaml and the "Feature request" link (pointing to URLO) offer to handle feature requests in two different ways. For slightly different things.

"Feature request" is included in the descriptions of these two places. This may make people who open it for the first time a little confused. So simply say "Create a report for a change to rustc's error output" here.

@apiraino
Copy link
Contributor

apiraino commented Aug 11, 2025

So, reading the discussion on Zulip I think there is perhaps a suggestion (see comment) that could be an improvement

  • in the documentation.yaml clarify that for rustdoc issues we have a dedicated template, point to it
  • "Problem with rustdoc" as title in rustdoc.md could be a bit more explicit
  • rename this PR title to reflect the intent (and avoid confusion)
  • the other changes could probably be reverted, we don't have a clear feedback about them

We should be careful and deliberate with changes like these because these templates are at the frontline of our issue tracker 🙂

@rustbot author

@rustbot rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 11, 2025
@xizheyin xizheyin changed the title Change the wording in diagnostic.yaml to reduce confusion Improve "rustdoc.md" issue template Aug 11, 2025
@xizheyin
Copy link
Member Author

these templates are at the frontline of our issue tracker

I understand, thank you. :)

in the documentation.yaml clarify that for rustdoc issues we have a dedicated template, point to it

#145130 has done it.

"Problem with rustdoc" as title in rustdoc.md could be a bit more explicit

I rename it to Problen with rustdoc tool to be clear. I change the title of PR and revert other changes.

@rustbot ready

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Aug 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants