Skip to content

Commit 501c72b

Browse files
committed
monkeypatch matplotlib Polygon docstring
Other attempts: - try importing into namespace - add CapStyle to aliases and / or ignores - maybe nitpick exceptions? Signed-off-by: Nathaniel Starkman (@nstarman) <[email protected]>
1 parent d7cd264 commit 501c72b

2 files changed

Lines changed: 11 additions & 3 deletions

File tree

‎astropy/visualization/wcsaxes/patches.py‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,19 @@
88
from astropy.coordinates.representation import UnitSphericalRepresentation
99
from astropy.coordinates.matrix_utilities import rotation_matrix, matrix_product
1010

11-
1211
__all__ = ['Quadrangle', 'SphericalCircle']
1312

13+
# TODO upstream fix
14+
# monkey-patch the docs to fix CapStyle and JoinStyle subs.
15+
Polygon.__init__.__doc__ = Polygon.__init__.__doc__.replace(
16+
"`.CapStyle`", "``matplotlib._enums.CapStyle``")
17+
Polygon.__init__.__doc__ = Polygon.__init__.__doc__.replace(
18+
"`.JoinStyle`", "``matplotlib._enums.JoinStyle``")
19+
Polygon.set_capstyle.__doc__ = Polygon.set_capstyle.__doc__.replace(
20+
"`.CapStyle`", "``matplotlib._enums.CapStyle``")
21+
Polygon.set_joinstyle.__doc__ = Polygon.set_joinstyle.__doc__.replace(
22+
"`.JoinStyle`", "``matplotlib._enums.JoinStyle``")
23+
1424

1525
def _rotate_polygon(lon, lat, lon0, lat0):
1626
"""

‎docs/conf.py‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,6 @@ def minvers(name):
150150
"buffer-like": ":term:buffer-like",
151151
# for matplotlib
152152
"color": ":term:`color`",
153-
"CapStyle": ":class:`matplotlib._enums.CapStyle`",
154-
"JoinStyle": ":class:`matplotlib._enums.JoinStyle`",
155153
# for astropy
156154
"-like": ":term:`-like`",
157155
"unit-like": ":term:`unit-like`",

0 commit comments

Comments
 (0)