Repository navigation
[MNT]: document linestyle as an mpltype #28745
Description
Summary
The manual docs for linestyle in #27996 have me thinking of the ideas in #18664 and that we can do a simplified version of this using :mpltypes and _docstring.interp that we can then use to have a consistent way to document linestyle across the library.
Proposed fix
- Make something the following table
linestyle_docfor _docstyle.interpd:
========================================== =================
linestyle description
========================================== =================
``'-'`` ``'solid'`` solid line
``'--'`` or ``'dashed'`` dashed line
``'-.'`` or ``'dashdot'`` dash-dotted line
``':'`` or ``'dotted'`` dotted line
``'none'``, ``'None'``, ``' '``, or ``''`` draw nothing
========================================== =================- Add something like that table to linestyles reference (apparently can't reuse the interp in examples :/)
- Add linestyles and a link to the linestyles reference to
matplotlib/lib/matplotlib/sphinxext/roles.py
Lines 126 to 128 in 436a12a
Reacted by Ruth Comer
Activity
timhoffm commentedon Aug 22, 2024
To be clear, the purpose of
:mpltype:is to create links for type-like concepts that do not have a direct class representation. Linestyle does fall into this category. The usage should be weighted; disadvantage: indirection, advantage: concise description.Note that mpltype and interpolation are independent concepts.
story645 commentedon Aug 22, 2024
Yeah, and I debated pulling out the interpolation request here b/c I think just defining it as an mpltype and cleaning up the reference page should work here.
But they're also both ways of building canonical/source of truth docs & I think it'd improve consistency if we could move to that for things that are reused all over the place.
amishamehta99 commentedon Mar 14, 2026
Hi @story645
Hi! I’m interested in working on this issue.
From my understanding, the task is to document
linestyleusing:mpltype:and add a reference table in the linestyles documentation for consistency across the library.Please let me know if this issue is still available or if there is a specific part you would recommend starting with. I’d be happy to contribute.