8000 Merge pull request #15804 from anntzer/docsclean · matplotlib/matplotlib@08008d5 · GitHub
[go: up one dir, main page]
Skip to content

Commit 08008d5

Browse files
timhoffmtimhoffm
authored
Merge pull request #15804 from anntzer/docsclean
Cleanup many docstrings.
2 parents 8221bf4 + c8aab4a commit 08008d5

File tree

44 files changed

+443
-535
lines changed
  • pyplot.py
  • quiver.py
  • scale.py
  • streamplot.py
  • text.py
  • textpath.py
  • ticker.py
  • tri
  • widgets.py
  • mpl_toolkits

    • Some content is hidden

    Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

    44 files changed

    +443
    -535
    lines changed

    ‎examples/lines_bars_and_markers/filled_step.py

    Lines changed: 2 additions & 2 deletions
    Original file line numberDiff line numberDiff line change
    @@ -92,8 +92,8 @@ def stack_hist(ax, stacked_data, sty_cycle, bottoms=None,
    9292
    sty_cycle : Cycler or operable of dict
    9393
    Style to apply to each set
    9494
    95-
    bottoms : array, optional
    96-
    The initial positions of the bottoms, defaults to 0
    95+
    bottoms : array, optional, default: 0
    96+
    The initial positions of the bottoms.
    9797
    9898
    hist_func : callable, optional
    9999
    Must have signature `bin_vals, bin_edges = f(data)`.

    ‎lib/matplotlib/_cm.py

    Lines changed: 14 additions & 16 deletions
    Original file line numberDiff line numberDiff line change
    @@ -84,22 +84,20 @@ def cubehelix(gamma=1.0, s=0.5, r=-1.5, h=1.0):
    8484
    element. This color element is calculated in a plane of constant
    8585
    perceived intensity and controlled by the following parameters.
    8686
    87-
    Optional keyword arguments:
    88-
    89-
    ========= =======================================================
    90-
    Keyword Description
    91-
    ========= =======================================================
    92-
    gamma gamma factor to emphasise either low intensity values
    93-
    (gamma < 1), or high intensity values (gamma > 1);
    94-
    defaults to 1.0.
    95-
    s the start color; defaults to 0.5 (i.e. purple).
    96-
    r the number of r, g, b rotations in color that are made
    97-
    from the start to the end of the color scheme; defaults
    98-
    to -1.5 (i.e. -> B -> G -> R -> B).
    99-
    h the hue parameter which controls how saturated the
    100-
    colors are. If this parameter is zero then the color
    101-
    scheme is purely a greyscale; defaults to 1.0.
    102-
    ========= =======================================================
    87+
    Parameters
    88+
    ----------
    89+
    gamma : float, optional, default: 1
    90+
    Gamma factor emphasizing either low intensity values (gamma < 1), or
    91+
    high intensity values (gamma > 1).
    92+
    s : float, optional, default: 0.5 (purple)
    93+
    The starting color.
    94+
    r : float, optional, default: -1.5
    95+
    The number of r, g, b rotations in color that are made from the start
    96+
    to the end of the color scheme. The default of -1.5 corresponds to ->
    97+
    B -> G -> R -> B.
    98+
    h : float, optional, default: 1
    < 52C8 /code>99+
    The hue, i.e. how saturated the colors are. If this parameter is zero
    100+
    then the color scheme is purely a greyscale.
    103101
    """
    104102
    return {'red': partial(_ch_helper, gamma, s, r, h, -0.14861, 1.78277),
    105103
    'green': partial(_ch_helper, gamma, s, r, h, -0.29227, -0.90649),

    0 commit comments

    Comments
     (0)
    0