Repository navigation
Commit 2c30e96
committed
DOC: Fix non-working code object references
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 the references:
- `AxesBase` is not documented itself and in the given context, we don't
have to make the specific distinction, so just link `Axes`
- The datalim attribute is documented as part of the Axes class, but
does not have a dedicated target to link to. So we simply use a
literal instead of a link.1 parent 56153b9 commit 2c30e96
1 file changed
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2265,7 +2265,7 @@ def add_artist(self, a): | |||
| 2265 | 2265 | ||
| 2266 | 2266 | def add_child_axes(self, ax): | |
| 2267 | 2267 | """ | |
| 2268 | - Add an `.AxesBase` to the Axes' children; return the child Axes. | ||
| 2268 | + Add an `.Axes` to the Axes' children; return the child Axes. | ||
| 2269 | 2269 | ||
| 2270 | 2270 | This is the lowlevel version. See `.axes.Axes.inset_axes`. | |
| 2271 | 2271 | """ | |
@@ -2524,7 +2524,7 @@ def relim(self, visible_only=False): | |||
| 2524 | 2524 | ||
| 2525 | 2525 | def update_datalim(self, xys, updatex=True, updatey=True): | |
| 2526 | 2526 | """ | |
| 2527 | - Extend the `~.Axes.dataLim` Bbox to include the given points. | ||
| 2527 | + Extend the ``Axes.dataLim`` Bbox to include the given points. | ||
| 2528 | 2528 | ||
| 2529 | 2529 | If no data is set currently, the Bbox will ignore its limits and set | |
| 2530 | 2530 | the bound to be the bounds of the xydata (*xys*). Otherwise, it will | |
0 commit comments