Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Fix doc bugs found in 3.5.3#23641

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
tacaswell merged 3 commits intomatplotlib:mainfromQuLogic:fix-doc-bugs
Aug 17, 2022
Merged

Conversation

QuLogic
Copy link
Member

PR Summary

This fixes several dead links and HTML errors found after building docs for 3.5.3.

PR Checklist

Tests and Styling

  • [n/a] Has pytest style unit tests (andpytest passes).
  • IsFlake 8 compliant (installflake8-docstrings and runflake8 --docstring-convention=all).

Documentation

  • [n/a] New features are documented, with examples if plot related.
  • [n/a] New features have an entry indoc/users/next_whats_new/ (follow instructions in README.rst there).
  • [n/a] API changes documented indoc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).

Though these are not intended to be seen, this silences validators.
The anchor ID was changed, but as this was entered manually, it did notbreak the build.Instead, insert a pending cross-reference so that Sphinx will resolve itand warn if it breaks.The output changes minimally from `external` to `internal` class, andalso gains `std std-ref` classes due to it being a standard reference.
@QuLogicQuLogic added this to thev3.5-doc milestoneAug 16, 2022
@tfpf
Copy link
Contributor

Since a link intest_quiver.py has also been updated, can this dead link be updated, too?

# https://developer.mozilla.org/en-US/docs/Mozilla/MathML_Project/MathML_Torture_Test

I thinkhttps://www-archive.mozilla.org/projects/mathml/demo/texvsmml.xhtml is the correct one.

@tacaswell
Copy link
Member

@tfpf Can you open a PR with that change?

tfpf reacted with thumbs up emoji

@tacaswelltacaswell merged commit944b99a intomatplotlib:mainAug 17, 2022
@lumberbot-app
Copy link

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.5.xgit pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 944b99a826a1b3509cbf7add49dccb14db9240fb
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #23641: Fix doc bugs found in 3.5.3'
  1. Push to a named branch:
git push YOURFORK v3.5.x:auto-backport-of-pr-23641-on-v3.5.x
  1. Create a PR against branch v3.5.x, I would have named this PR:

"Backport PR#23641 on branch v3.5.x (Fix doc bugs found in 3.5.3)"

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 theStill Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free tosuggest an improvement.

@lumberbot-app
Copy link

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.5.3-docgit pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 944b99a826a1b3509cbf7add49dccb14db9240fb
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #23641: Fix doc bugs found in 3.5.3'
  1. Push to a named branch:
git push YOURFORK v3.5.3-doc:auto-backport-of-pr-23641-on-v3.5.3-doc
  1. Create a PR against branch v3.5.3-doc, I would have named this PR:

"Backport PR#23641 on branch v3.5.3-doc (Fix doc bugs found in 3.5.3)"

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 theStill Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free tosuggest an improvement.

@QuLogicQuLogic deleted the fix-doc-bugs branchAugust 17, 2022 21:34
QuLogic pushed a commit to QuLogic/matplotlib that referenced this pull requestAug 17, 2022
QuLogic pushed a commit to QuLogic/matplotlib that referenced this pull requestAug 17, 2022
QuLogic added a commit that referenced this pull requestAug 17, 2022
…3.5.3-docBackport PR#23641 on branch v3.5.3-doc (Fix doc bugs found in 3.5.3)
QuLogic added a commit that referenced this pull requestAug 17, 2022
…3.5.xBackport PR#23641 on branch v3.5.x (Fix doc bugs found in 3.5.3)
@QuLogicQuLogic mentioned this pull requestAug 26, 2022
2 tasks
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@tacaswelltacaswelltacaswell approved these changes

Assignees
No one assigned
Projects
None yet
Milestone
v3.5-doc
Development

Successfully merging this pull request may close these issues.

3 participants
@QuLogic@tfpf@tacaswell
[8]ページ先頭
©2009-2025 Movatter.jp