Skip to content

DOC: link out to troubleshooting guide in install #27226

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

Merged
merged 1 commit into from
Oct 30, 2023

Conversation

story645
Copy link
Member

PR summary

Per #27168 (comment), figured it wouldn't hurt to signpost "hey, we have a troubleshooting section over there (that links to our other troubleshooting section)" Went slightly more general than that comment suggested just because there's more than just Windows mentioned in the troubleshooting guide.

@@ -173,6 +173,10 @@ When working on a branch that does not have Meson enabled, meaning it does not
have :ghpull:`26621` in its history (log), you will have to reinstall from source
each time you change any compiled extension code.

If the installation is not working, please consult the :ref:`troubleshooting guide <troubleshooting-faq>`
for a potential solution before filing a bug report or reaching out to us.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
for a potential solution before filing a bug report or reaching out to us.
for a potential solution.

It reads a bit less defensive this way.

Copy link
Member Author

Choose a reason for hiding this comment

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

I meant it in the opposite - if it's not in the guide you should reach out. Let me rewrite that .

Copy link
Member

@tacaswell tacaswell left a comment

Choose a reason for hiding this comment

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

Looks good with or without my suggested edit.

@story645 can merge at her discretion.

@tacaswell tacaswell added this to the v3.8.1 milestone Oct 30, 2023
@ksunden ksunden merged commit b318dbf into matplotlib:main Oct 30, 2023
@lumberbot-app
Copy link

lumberbot-app bot commented Oct 30, 2023

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.8.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 b318dbfd80b22709e269b3e7d0cad6e3312a2561
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #27226: DOC: link out to troubleshooting guide in install'
  1. Push to a named branch:
git push YOURFORK v3.8.x:auto-backport-of-pr-27226-on-v3.8.x
  1. Create a PR against branch v3.8.x, I would have named this PR:

"Backport PR #27226 on branch v3.8.x (DOC: link out to troubleshooting guide in install)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

ksunden added a commit to ksunden/matplotlib that referenced this pull request Oct 30, 2023
story645 added a commit that referenced this pull request Oct 30, 2023
…3.8.x

Backport PR #27226 on branch v3.8.x (DOC: link out to troubleshooting guide in install)
@ksunden ksunden mentioned this pull request Nov 2, 2023
5 tasks
@story645 story645 deleted the vsenv branch May 2, 2024 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: devdocs files in doc/devel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants