René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Subclasses of Polygon with numpydoc xref throws error b/c of CapStyle, JoinStyle","articleBody":"\u003c!--To help us understand and resolve your issue, please fill out the form to the best of your ability.--\u003e\r\n\u003c!--You can feel free to delete the sections that do not apply.--\u003e\r\n\r\n### Problem\r\n\r\nThe sphinx links to `CapStyle`  and `JoinStyle` in v3.4.0 are relative to the file, so a subclass of `matplotlib.patches.Patch` in a package with numpydoc xref (https://numpydoc.readthedocs.io/en/latest/install.html) turned on cannot link to the objects and errors with.\r\n```WARNING: py:obj reference target not found: CapStyle```\r\n```WARNING: py:obj reference target not found: JoinStyle```\r\n\r\nhttps://matplotlib.org/stable/api/_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_capstyle\r\nhttps://matplotlib.org/stable/api/_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch.set_joinstyle\r\n\r\n```\r\n   @docstring.interpd\r\n    def set_capstyle(self, s):\r\n        \"\"\"\r\n        Set the `.CapStyle`.\r\n\r\n        Parameters\r\n        ----------\r\n        s : `.CapStyle` or %(CapStyle)s\r\n        \"\"\"\r\n        cs = CapStyle(s)\r\n        self._capstyle = cs\r\n        self.stale = True\r\n```\r\n\r\n**Edit:**\r\n\r\nThe problem also appears to involve ``Patches.__init__``. I can monkey-patch a fix with \r\n\r\n```\r\nPolygon.__init__.__doc__ = Polygon.__init__.__doc__.replace(\r\n    \"`.CapStyle`\", \"``matplotlib._enums.CapStyle``\")\r\nPolygon.__init__.__doc__ = Polygon.__init__.__doc__.replace(\r\n    \"`.JoinStyle`\", \"``matplotlib._enums.JoinStyle``\")\r\nPolygon.set_capstyle.__doc__ = Polygon.set_capstyle.__doc__.replace(\r\n    \"`.CapStyle`\", \"``matplotlib._enums.CapStyle``\")\r\nPolygon.set_joinstyle.__doc__ = Polygon.set_joinstyle.__doc__.replace(\r\n    \"`.JoinStyle`\", \"``matplotlib._enums.JoinStyle``\")\r\n```\r\n\r\n### Suggested Improvement\r\n\r\n* This line could be be changed to say\r\n```\r\n   @docstring.interpd\r\n    def set_capstyle(self, s):\r\n        \"\"\"\r\n        Set the `~matplotlib._enums.CapStyle`.\r\n\r\n        Parameters\r\n        ----------\r\n        s : `~matplotlib._enums.CapStyle` or %(CapStyle)s\r\n        \"\"\"\r\n        cs = CapStyle(s)\r\n        self._capstyle = cs\r\n        self.stale = True\r\n```\r\n\r\n\u003c!--\r\nIf you have an idea to improve the documentation please suggest it here\r\n\r\n* This line should be be changed to say [...]\r\n* Include a paragraph explaining [...]\r\n* Add a figure showing [...]\r\n--\u003e\r\n\r\n**Matplotlib version**\r\n\u003c!--Please specify the version of matplotlib and the version of the documentation that you are using:--\u003e\r\n  * Operating system: Big Sur \u0026 Ubuntu\r\n  * Matplotlib version 3.4.0\r\n  * Matplotlib documentation version (is listed under the logo): 3.4.0\r\n","author":{"url":"https://github.com/nstarman","@type":"Person","name":"nstarman"},"datePublished":"2021-03-31T19:03:22.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":18},"url":"https://github.com/19839/matplotlib/issues/19839"}