<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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" />
<title>Adding API change notes — Matplotlib 3.2.0 documentation</title>
<link rel="stylesheet" href="../../_static/mpl.css?v3.2.0-3-gea62ccde8" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.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/language_data.js"></script>
<script src="../../_static/clipboard.min.js"></script>
<script src="../../_static/copybutton.js"></script>
<script >var copybuttonSkipText = '>>> ';</script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.2.0 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" href="../matplotlib_configuration_api.html" />
<link rel="prev" title="Changes for 0.40" href="../prev_api_changes/api_changes_0.40.html" />
<link rel="top" title="Matplotlib 3.2.0 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/next_api_changes/README.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.2.0). For the latest version see <a href="https://matplotlib.org/stable/api/next_api_changes/README.html">https://matplotlib.org/stable/api/next_api_changes/README.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.2.0</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"/>
</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="../matplotlib_configuration_api.html" title="matplotlib"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../prev_api_changes/api_changes_0.40.html" title="Changes for 0.40"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">home</a>| </li>
<li><a href="../../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" >API Overview</a> »</li>
<li class="nav-item nav-item-2"><a href="../api_changes.html" accesskey="U">API Changes</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
<li><a href="../index.html">API Overview</a><ul>
<li><a href="../api_changes.html">API Changes</a><ul>
<li>Previous: <a href="../prev_api_changes/api_changes_0.40.html" title="previous chapter">Changes for 0.40</a></li>
<li>Next: <a href="../matplotlib_configuration_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib</span></code></a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
<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/next_api_changes/README.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="adding-api-change-notes">
<h1>Adding API change notes<a class="headerlink" href="#adding-api-change-notes" title="Permalink to this headline">¶</a></h1>
<p>Please place new portions of <code class="xref py py-obj docutils literal notranslate"><span class="pre">api_changes.rst</span></code> in the
<code class="xref py py-obj docutils literal notranslate"><span class="pre">next_api_changes</span></code> directory.</p>
<p>When adding an entry please look at the currently existing files to
see if you can extend any of them. If you create a file, name it
<code class="file docutils literal notranslate"><span class="pre">what_api_changes.rst</span></code> (ex <code class="file docutils literal notranslate"><span class="pre">deprecated_rcparams.rst</span></code>) with
contents following the form:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Brief</span> <span class="n">description</span> <span class="n">of</span> <span class="n">change</span>
<span class="o">---------------------------</span>
<span class="n">Long</span> <span class="n">description</span> <span class="n">of</span> <span class="n">change</span><span class="p">,</span> <span class="n">justification</span><span class="p">,</span> <span class="ow">and</span> <span class="n">work</span><span class="o">-</span><span class="n">arounds</span> <span class="n">to</span>
<span class="n">maintain</span> <span class="n">old</span> <span class="n">behavior</span> <span class="p">(</span><span class="k">if</span> <span class="nb">any</span><span class="p">)</span><span class="o">.</span>
</pre></div>
</div>
<p>If you need more heading levels, please use <code class="docutils literal notranslate"><span class="pre">~~~~</span></code> and <code class="docutils literal notranslate"><span class="pre">++++</span></code>.</p>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.
<br />
Last updated on Mar 04, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 2.4.3.
Doc version v3.2.0-3-gea62ccde8.
</div>
</footer>
</body>
</html>