Commit 0803339
committed
Fix missing artist property reference for _CollectionWithSizes.set_sizes
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.
Note: One could 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. It's an important fix because it removes `set_sizes` from
`missing-references.json`. 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
matplotlib#29044 - and is really annoying.
there1 parent 46ea8f0 commit 0803339
2 files changed
+13
-34
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
143 | 143 | | |
144 | 144 | | |
145 | 145 | | |
146 | | - | |
147 | | - | |
148 | | - | |
149 | | - | |
150 | | - | |
151 | | - | |
152 | | - | |
153 | | - | |
154 | | - | |
155 | | - | |
156 | | - | |
157 | | - | |
158 | | - | |
159 | | - | |
160 | | - | |
161 | | - | |
162 | | - | |
163 | | - | |
164 | | - | |
165 | | - | |
166 | | - | |
167 | | - | |
168 | | - | |
169 | | - | |
170 | | - | |
171 | | - | |
172 | | - | |
173 | | - | |
174 | | - | |
175 | | - | |
176 | | - | |
177 | | - | |
178 | 146 | | |
179 | 147 | | |
180 | 148 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1572 | 1572 | | |
1573 | 1573 | | |
1574 | 1574 | | |
| 1575 | + | |
| 1576 | + | |
| 1577 | + | |
| 1578 | + | |
| 1579 | + | |
| 1580 | + | |
| 1581 | + | |
1575 | 1582 | | |
1576 | 1583 | | |
1577 | 1584 | | |
| |||
1640 | 1647 | | |
1641 | 1648 | | |
1642 | 1649 | | |
1643 | | - | |
1644 | | - | |
| 1650 | + | |
| 1651 | + | |
| 1652 | + | |
| 1653 | + | |
| 1654 | + | |
| 1655 | + | |
1645 | 1656 | | |
1646 | 1657 | | |
1647 | 1658 | | |
| |||
0 commit comments