<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="X-UA-Compatible" content="IE=Edge" />

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>matplotlib.docstring &#8212; Matplotlib 3.4.3 documentation</title>

<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

<link rel="stylesheet" href="../_static/mpl.css?v3.4.3-2-ge48e4acce0" type="text/css" />

<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />

<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />

<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />

<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />

<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />

<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />

<link rel="stylesheet" type="text/css" href="../_static/gallery-rendered-html.css" />

<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>

<script src="../_static/jquery.js"></script>

<script src="../_static/underscore.js"></script>

<script src="../_static/doctools.js"></script>

<script src="../_static/clipboard.min.js"></script>

<script src="../_static/copybutton.js"></script>

<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>

<link rel="search" type="application/opensearchdescription+xml"

title="Search within Matplotlib 3.4.3 documentation"

href="../_static/opensearch.xml"/>

<link rel="shortcut icon" href="../_static/favicon.ico"/>

<link rel="index" title="Index" href="../genindex.html" />

<link rel="search" title="Search" href="../search.html" />

<link rel="next" title="matplotlib.dviread" href="dviread.html" />

<link rel="prev" title="matplotlib.dates" href="dates_api.html" />

<link rel="top" title="Matplotlib 3.4.3 documentation" href="#" />

<link rel="canonical" href="https://matplotlib.org/stable/api/docstring_api.html" />

<link rel="stylesheet" href="../_static/custom.css" type="text/css" />

<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>

</head><body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.4.3). For the latest version see <a href="https://matplotlib.org/stable/api/docstring_api.html">https://matplotlib.org/stable/api/docstring_api.html</a></div>

<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">

<a href="../index.html">

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.4.3</span></div>

<img src="../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>

<!-- The "Fork me on github" ribbon -->

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<nav class="main-nav">

<ul>

<li><a href="../users/installing.html">Installation</a></li>

<li><a href="../contents.html">Documentation</a></li>

<li><a href="../gallery/index.html">Examples</a></li>

<li><a href="../tutorials/index.html">Tutorials</a></li>

<li><a href="../devel/index.html">Contributing</a></li>

<li class="nav-right">

<form class="search" action="../search.html" method="get">

<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>

</form>

</li>

</ul>

</nav>

<div class="related" role="navigation" aria-label="related navigation">

<h3>Navigation</h3>

<ul>

<li class="right" style="margin-right: 10px">

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<li class="right" >

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="right" >

<a href="dviread.html" title="matplotlib.dviread"

accesskey="N">next</a> |</li>

<li class="right" >

<a href="dates_api.html" title="matplotlib.dates"

accesskey="P">previous</a> |</li>

<li><a href="../index.html">home</a>|&nbsp;</li>

<li><a href="../contents.html">contents</a> &raquo;</li>

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> &#187;</li>

<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">matplotlib.docstring</span></code></a></li>

</ul>

</div>

<div class="sphinxsidebar" role="navigation" aria-label="main navigation">

<div class="sphinxsidebarwrapper">

<div id="sidebar-pagesource" role="note" aria-label="source link"

style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">

<a href="../_sources/api/docstring_api.rst.txt"

style="color: #c0c0c0" rel="nofollow">Show Page Source</a>

</div>

</div>

</div>

<div class="document">

<div class="documentwrapper">

<div class="bodywrapper">

<div class="body" role="main">

<div class="section" id="module-matplotlib.docstring">

<span id="matplotlib-docstring"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.docstring</span></code><a class="headerlink" href="#module-matplotlib.docstring" title="Permalink to this headline">¶</a></h1>

<dl class="py class">

<dt id="matplotlib.docstring.Substitution">

<em class="property">class </em><code class="descclassname">matplotlib.docstring.</code><code class="descname">Substitution</code><span class="sig-paren">(</span><em><span class="o">*</span><span class="n">args</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/docstring.html#Substitution"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.docstring.Substitution" title="Permalink to this definition">¶</a></dt>

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<p>A decorator that performs %-substitution on an object's docstring.</p>

<p>This decorator should be robust even if <code class="docutils literal notranslate"><span class="pre">obj.__doc__</span></code> is None (for

example, if -OO was passed to the interpreter).</p>

<p>Usage: construct a docstring.Substitution with a sequence or dictionary

suitable for performing substitution; then decorate a suitable function

with the constructed object, e.g.:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sub_author_name</span> <span class="o">=</span> <span class="n">Substitution</span><span class="p">(</span><span class="n">author</span><span class="o">=</span><span class="s1">&#39;Jason&#39;</span><span class="p">)</span>

<span class="nd">@sub_author_name</span>

<span class="k">def</span> <span class="nf">some_function</span><span class="p">(</span><span class="n">x</span><span class="p">):</span>

<span class="s2">&quot;</span><span class="si">%(author)s</span><span class="s2"> wrote this function&quot;</span>

<span class="c1"># note that some_function.__doc__ is now &quot;Jason wrote this function&quot;</span>

<p>One can also use positional arguments:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sub_first_last_names</span> <span class="o">=</span> <span class="n">Substitution</span><span class="p">(</span><span class="s1">&#39;Edgar Allen&#39;</span><span class="p">,</span> <span class="s1">&#39;Poe&#39;</span><span class="p">)</span>

<span class="nd">@sub_first_last_names</span>

<span class="k">def</span> <span class="nf">some_function</span><span class="p">(</span><span class="n">x</span><span class="p">):</span>

<span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> wrote the Raven&quot;</span>

<dl class="py method">

<dt id="matplotlib.docstring.Substitution.update">

<code class="descname">update</code><span class="sig-paren">(</span><em><span class="o">*</span><span class="n">args</span></em>, <em><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/docstring.html#Substitution.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.docstring.Substitution.update" title="Permalink to this definition">¶</a></dt>

<dd><p>Update <code class="docutils literal notranslate"><span class="pre">self.params</span></code> (which must be a dict) with the supplied args.</p>

<dl class="py function">

<dt id="matplotlib.docstring.copy">

<code class="descclassname">matplotlib.docstring.</code><code class="descname">copy</code><span class="sig-paren">(</span><em><span class="n">source</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/docstring.html#copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.docstring.copy" title="Permalink to this definition">¶</a></dt>

<dd><p>Copy a docstring from another source function (if present).</p>

</div>

</div>

</div>

<div class="clearer"></div>

</div>

<div class="footer">

&copy; Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2021 The Matplotlib development team.

<br />

Last updated on Aug 13, 2021.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 3.4.3.

Doc version v3.4.3-2-ge48e4acce0.

</div>

</body>