Skip to content

DOC: Fix non-working code object references #28825

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
Sep 24, 2024
Merged

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Sep 16, 2024

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 timhoffm added this to the v3.9.3 milestone Sep 16, 2024
@timhoffm
Copy link
Member Author

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

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

QuLogic commented Sep 17, 2024

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
Member Author

Choose a reason for hiding this comment

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

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 QuLogic merged commit 613c9c9 into matplotlib:main Sep 24, 2024
40 of 43 checks passed
Copy link

lumberbot-app bot commented Sep 24, 2024

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.

@timhoffm
Copy link
Member Author

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

@timhoffm timhoffm modified the milestones: v3.9.3, v3.10.0 Sep 24, 2024
@timhoffm 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
kyracho pushed a commit to kyracho/matplotlib that referenced this pull request Oct 10, 2024
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