Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[DOC] Update missing-references.json #29058

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
Nov 1, 2024
Merged

Conversation

ksunden
Copy link
Member

@ksunden ksunden commented Oct 31, 2024

Problems were introduced by #28048, specifically relating to set_sizes.

I simply ran with the flag to regenerate, so more changes were made, which I do not fully understand why they were not problematic earlier.

PR summary

PR checklist

@QuLogic
Copy link
Member

QuLogic commented Oct 31, 2024

This seems to have had the opposite effect; more warnings are issued afaict.

@ksunden
Copy link
Member Author

ksunden commented Oct 31, 2024

Yeah, seeing if it was a version problem on my local env...

Problems were introduced by matplotlib#28048, specifically relating to set_sizes. I simply ran with the flag to regenerate, so more changes were made, which I do not fully understand why they were not problematic earlier.
@ksunden
Copy link
Member Author

ksunden commented Nov 1, 2024

Running updates helped, but one tutorial file (artists) was off by 3 lines somehow...

I think it should be good now...

@QuLogic QuLogic merged commit 9b8f11b into matplotlib:main Nov 1, 2024
31 of 32 checks passed
@QuLogic QuLogic added this to the v3.10.0 milestone Nov 1, 2024
@Impaler343
Copy link
Contributor

Could somebody elaborate how #28048 caused unwanted changes?

Problems were introduced by #28048, specifically relating to set_sizes.

@ksunden
Copy link
Member Author

ksunden commented Nov 1, 2024

It has to do with how Artist docstrings are rendered, which includes some templating. We noticed the doc build failure on the PR, but we're not 100% sure it would be a problem once merged, so we went through with the merge and sorted it out after it did indeed fail.

In short, there are cross references in the docs that are pointing to methods that aren't actually rendered in the docs (because they exist on a private class). We have a way of ignoring the errors, but it relies on the line number matching, so if something changes (in this case I think it was adding a method) the ignores need updating.

@Impaler343
Copy link
Contributor

I see, thanks!

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.

3 participants