Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[MNT]: document linestyle as an mpltype #28745

Copy link
Copy link
Open
@story645

Description

@story645
Issue body actions

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

  1. Make something the following table linestyle_doc for _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
              ==========================================  =================
  1. Add something like that table to linestyles reference (apparently can't reuse the interp in examples :/)
  2. Add linestyles and a link to the linestyles reference to
    type_to_link_target = {
    'color': 'colors_def',
    }

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.