Skip to content

Fix doc build #26817

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.

Sign up for GitHub

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

Closed
timhoffm wants to merge 1 commit into from
Closed

Fix doc build #26817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Fix doc build 
Attempt to fix doc build failure introduced with #25272.

I suspect this is sphinx scoping: #25272 reused methods
like `Axes.set_xbounds` to generate documentation for Axes3D. However,
a see also of invert_xaxis only searches within the same module (or
class), and invert_xaxis is not documented for Axes3D. This PR broadens
the search scope by using the leading dot. An alternative may be to
attempt to explicitly document the missing methods for Axes3D.
  • Loading branch information
@timhoffm
timhoffm committed Sep 18, 2023
commit 0d8ec10dbd325572a46612a0dcd33ba53bb992d3
8 changes: 4 additions & 4 deletions lib/matplotlib/axes/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3534,7 +3534,7 @@ def get_xbound(self):
--------
set_xbound
get_xlim, set_xlim
invert_xaxis, xaxis_inverted
.invert_xaxis, .xaxis_inverted
"""
left, right = self.get_xlim()
if left < right:
Expand All @@ -3561,7 +3561,7 @@ def set_xbound(self, lower=None, upper=None):
--------
get_xbound
get_xlim, set_xlim
invert_xaxis, xaxis_inverted
.invert_xaxis, .xaxis_inverted
"""
if upper is None and np.iterable(lower):
lower, upper = lower
Expand Down Expand Up @@ -3787,7 +3787,7 @@ def get_ybound(self):
--------
set_ybound
get_ylim, set_ylim
invert_yaxis, yaxis_inverted
.invert_yaxis, .yaxis_inverted
"""
bottom, top = self.get_ylim()
if bottom < top:
Expand All @@ -3814,7 +3814,7 @@ def set_ybound(self, lower=None, upper=None):
--------
get_ybound
get_ylim, set_ylim
invert_yaxis, yaxis_inverted
.invert_yaxis, .yaxis_inverted
"""
if upper is None and np.iterable(lower):
lower, upper = lower
Expand Down
4 changes: 2 additions & 2 deletions lib/mpl_toolkits/mplot3d/axes3d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -860,7 +860,7 @@ def set_xlim(self, left=None, right=None, *, emit=True, auto=False,
--------
get_xlim
set_xbound, get_xbound
invert_xaxis, xaxis_inverted
.invert_xaxis, .xaxis_inverted

Notes
-----
Expand Down Expand Up @@ -932,7 +932,7 @@ def set_ylim(self, bottom=None, top=None, *, emit=True, auto=False,
--------
get_ylim
set_ybound, get_ybound
invert_yaxis, yaxis_inverted
.invert_yaxis, .yaxis_inverted

Notes
-----
Expand Down