FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

DOC: Fix non-working code object references by timhoffm · Pull Request #28825 · matplotlib/matplotlib · GitHub

Repository navigation

DOC: Fix non-working code object references - #28825

Merged
QuLogic merged 1 commit into
matplotlib:mainfrom
timhoffm:doc-fix
Sep 24, 2024
Merged

QuLogic merged 1 commit into
matplotlib:mainfrom
timhoffm:doc-fix

Conversation

timhoffm commented Sep 16, 2024 •
edited
Loading

Copy link
Copy Markdown
Member

These were not rendered as links in the current docs, because the
associated code objects do not exist as targets in the docs. For some
reason, sphinx did not complain about it. But it does in some recent
PRs (extracted from #28560) - I'm unclear why, but anyway the correct
solution is to change to explicitly listing the attributes.

timhoffm added this to the v3.9.3 milestone Sep 16, 2024

Copy link
Copy Markdown
Member Author

Note: Failing OSX and free-threaded tests are an unrealted CI issue.

timhoffm marked this pull request as draft September 16, 2024 16:41
github-actions Bot added the Documentation: API files in lib/ and doc/api label Sep 17, 2024
timhoffm marked this pull request as ready for review September 17, 2024 07:03

QuLogic commented Sep 17, 2024

Copy link
Copy Markdown
Member

There's an exception for Axes.dataLim in doc/missing-references.json; can that be removed now?

These were not rendered as links in the current docs, because the
associated code objects do not exist as targets in the docs. For some
reason, sphinx did not complain about it. But it does in some recent
PRs (extracted from matplotlib#28560) - I'm unclear why, but anyway the correct
solution is to change to explicitly listing the attributes.
Comment on lines +554 to +555
dataLim: mtransforms.Bbox
"""The bounding `.Bbox` enclosing all data displayed in the Axes."""

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

We need a place to put the docstring. IMHO a class-level annotation is the best location (though we normally don't write types in the py files).

QuLogic merged commit 613c9c9 into matplotlib:main Sep 24, 2024

lumberbot-app Bot commented Sep 24, 2024

Copy link
Copy Markdown

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.9.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 613c9c996c20e034de67126e3e1cc42d19835b1f
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #28825: DOC: Fix non-working code object references'
  1. Push to a named branch:
git push YOURFORK v3.9.x:auto-backport-of-pr-28825-on-v3.9.x
  1. Create a PR against branch v3.9.x, I would have named this PR:

"Backport PR #28825 on branch v3.9.x (DOC: Fix non-working code object references)"

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.

Copy link
Copy Markdown
Member Author

Let's not bother with a manual backport since 3.10 is not that far away.

timhoffm modified the milestones: v3.9.3, v3.10.0 Sep 24, 2024
timhoffm deleted the doc-fix branch September 24, 2024 10:26
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Sep 25, 2024
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Sep 25, 2024
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Sep 25, 2024
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Sep 25, 2024
kc9323 pushed a commit to kc9323/matplotlib that referenced this pull request Oct 10, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants


Back | FazBrowse Home | New Git URL