René's URL Explorer Experiment

Title: Rely on Sphinx' "any" role to make docstrings more legible · Issue #7502 · matplotlib/matplotlib · GitHub

Open Graph Title: Rely on Sphinx' "any" role to make docstrings more legible · Issue #7502 · matplotlib/matplotlib

X Title: Rely on Sphinx' "any" role to make docstrings more legible · Issue #7502 · matplotlib/matplotlib

Description: Sphinx >=1.3 has the "any" role (http://www.sphinx-doc.org/en/1.4.8/markup/inline.html#role-any) which allows one to write e.g. `Axes` instead of :class:`Axes` and will automatically figure out the proper markup role (and warn if there i...

Open Graph Description: Sphinx >=1.3 has the "any" role (http://www.sphinx-doc.org/en/1.4.8/markup/inline.html#role-any) which allows one to write e.g. `Axes` instead of :class:`Axes` and will automatically figure out the...

X Description: Sphinx >=1.3 has the "any" role (http://www.sphinx-doc.org/en/1.4.8/markup/inline.html#role-any) which allows one to write e.g. `Axes` instead of :class:`Axes` and will automatically f...

Opengraph URL: https://github.com/matplotlib/matplotlib/issues/7502

X: @github

direct link

Domain: github.com

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Rely on Sphinx' \"any\" role to make docstrings more legible","articleBody":"Sphinx \u003e=1.3 has the \"any\" role (http://www.sphinx-doc.org/en/1.4.8/markup/inline.html#role-any) which allows one to write e.g.\r\n```\r\n`Axes`\r\n```\r\ninstead of\r\n```\r\n:class:`Axes`\r\n```\r\nand will automatically figure out the proper markup role (and warn if there is an ambiguity).\r\n\r\nThis would make non-rendered docstrings quite more readable.","author":{"url":"https://github.com/anntzer","@type":"Person","name":"anntzer"},"datePublished":"2016-11-22T19:25:21.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":4},"url":"https://github.com/7502/matplotlib/issues/7502"}

Links:

Viewport: width=device-width