Skip to content
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

Jump to bottom

[MNT]: Confusing prompt in docs issue template #22403

Closed
ianhi opened this issue Feb 5, 2022 · 1 comment · Fixed by #22419
Closed

[MNT]: Confusing prompt in docs issue template #22403

ianhi opened this issue Feb 5, 2022 · 1 comment · Fixed by #22419
Labels
Maintenance
Milestone
v3.6.0

Comments

@ianhi
Copy link
Contributor

ianhi commented Feb 5, 2022

Summary

In the docs issue template it prompts for the matplotlib version from python
image

this is confusing because I most interact with the docs via the browser

Proposed fix

change prompts to something like: "version of docs website"
@story645
Copy link
Member

story645 commented Feb 6, 2022 •
edited

I think the docs version was supposed to be taken care of by link to doc (is supposed to be the dev version) & this is supposed to be asking for library version, but agree it's confusing and either

  1. it should also ask for doc version w/ directions on how to find em
  2. the prompt should be more explicit "Matplotlib library version"

timhoffm added a commit to timhoffm/matplotlib that referenced this issue Feb 6, 2022
@timhoffm
Remove "Matplotlib version" from docs issue template
adad7d4 
We don't need the version installed by the user. If anything we need to
know the version of the docs the user is looking at.

Most of that is covered by the "Documentation Link" entry. It may point
to "stable" which could change contents in the future, but IMHO that's
not a practical problem.

Closes matplotlib#22403.
timhoffm added a commit to timhoffm/matplotlib that referenced this issue Feb 6, 2022
@timhoffm
Remove "Matplotlib version" from docs issue template
8f2320a 
We don't need the version installed by the user. If anything we need to
know the version of the docs the user is looking at.

Most of that is covered by the "Documentation Link" entry. It may point
to "stable" which could change contents in the future, but IMHO that's
not a practical problem.

Closes matplotlib#22403.
@timhoffm timhoffm mentioned this issue Feb 6, 2022
Merged
@QuLogic QuLogic added this to the v3.6.0 milestone Feb 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Maintenance
Projects
None yet
Milestone
v3.6.0
Development

Successfully merging a pull request may close this issue.

Remove "Matplotlib version" from docs issue template timhoffm/matplotlib
3 participants
@QuLogic @story645 @ianhi