Title: Fix missing artist property reference for _CollectionWithSizes.set_sizes by timhoffm · Pull Request #29560 · matplotlib/matplotlib · GitHub
Open Graph Title: Fix missing artist property reference for _CollectionWithSizes.set_sizes by timhoffm · Pull Request #29560 · matplotlib/matplotlib
X Title: Fix missing artist property reference for _CollectionWithSizes.set_sizes by timhoffm · Pull Request #29560 · matplotlib/matplotlib
Description: Child classes of _CollectionWithSizes that list all their properties via "%(MyClass:kwdoc)s" want to reference _CollectionWithSizes.set_sizes, but that is not documented because _CollectionWithSizes is not documented. Since all the child classes are documented with the option :inherited-members:, the child classes all explicitly document set_sizes themselves. This PR changes the link target to that. This fixes the broken link in all docstrings that list the possible kwarg values for collections such as in https://matplotlib.org/devdocs/api/_as_gen/matplotlib.axes.Axes.broken_barh.html: It also removes the need for _CollectionWithSizes.set_sizes entries in missing-references.json. This is important because the docstring line numbers that are hard-coded in there can change due to introduction of new properties or changes in the docstring above the "%(MyClass:kwdoc)s" placeholder, which has repeatedly lead to doc failures - latest affected PR is #29044 - and is really annoying. Note: One could alternatively consider documenting _CollectionWithSizes explicitly or even making it public. But these are larger decisions that I don't want to go into now, because that means reconsidering using the :inherited-members: for Collections documentation or even compatibility concerns when making it public. The fix here is well contained and can be reverted or adapted as needed in the future.
Open Graph Description: Child classes of _CollectionWithSizes that list all their properties via "%(MyClass:kwdoc)s" want to reference _CollectionWithSizes.set_sizes, but that is not documented because _Collecti...
X Description: Child classes of _CollectionWithSizes that list all their properties via "%(MyClass:kwdoc)s" want to reference _CollectionWithSizes.set_sizes, but that is not documented because _...
Opengraph URL: https://github.com/matplotlib/matplotlib/pull/29560
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:52246d60-829a-de77-28e2-87028af28abb |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | 8AAE:1D5589:178E65E:1F65AE5:6A52BE07 |
| html-safe-nonce | eb675b0f770c6c1df162652207ad0fd42f35381d7f4b5dbed1cf6cf470778e10 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4QUFFOjFENTU4OToxNzhFNjVFOjFGNjVBRTU6NkE1MkJFMDciLCJ2aXNpdG9yX2lkIjoiNjIzNjE2MzY1MzY3MjAyNTYwNyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | ed9944a0d93818317d79b8b6769391ea684ace92f4d901df34b76f195b6bb00e |
| hovercard-subject-tag | pull_request:2310795577 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/matplotlib/matplotlib/pull/29560/files |
| twitter:image | https://avatars.githubusercontent.com/u/2836374?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/2836374?s=400&v=4 |
| og:image:alt | Child classes of _CollectionWithSizes that list all their properties via "%(MyClass:kwdoc)s" want to reference _CollectionWithSizes.set_sizes, but that is not documented because _Collecti... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | b9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/matplotlib/matplotlib git https://github.com/matplotlib/matplotlib.git |
| octolytics-dimension-user_id | 215947 |
| octolytics-dimension-user_login | matplotlib |
| octolytics-dimension-repository_id | 1385122 |
| octolytics-dimension-repository_nwo | matplotlib/matplotlib |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1385122 |
| octolytics-dimension-repository_network_root_nwo | matplotlib/matplotlib |
| turbo-body-classes | logged-out env-production page-responsive full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 07a982c1d40157c619b364352b704c3ce66bb332 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width