next_api_changes
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
<!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="Content-Type" content="text/html; charset=utf-8" /> <title>Adding API change notes — Matplotlib 2.2.0 documentation</title> <link rel="stylesheet" href="../../_static/mpl.css" type="text/css" /> <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../../_static/gallery.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../../', VERSION: '2.2.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true, SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="../../_static/jquery.js"></script> <script type="text/javascript" src="../../_static/underscore.js"></script> <script type="text/javascript" src="../../_static/doctools.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Matplotlib 2.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="top" title="Matplotlib 2.2.0 documentation" href="../../index.html" /> <link rel="canonical" href="https://matplotlib.org/stable/api/next_api_changes/README.html" /> <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 (v2.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 2.2.0</span></div> <img src="../../_static/logo2.png" 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> <div class="related"> <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><a href="../../index.html">home</a>| </li> <li><a href="../../gallery/index.html">examples</a>| </li> <li><a href="../../tutorials/index.html">tutorials</a>| </li> <li><a href="../pyplot_summary.html">pyplot</a>| </li> <li><a href="../../contents.html">docs</a> »</li> </ul> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"><div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="../../contents.html">Documentation overview</a><ul> </ul></li> </ul> </div> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../../_sources/api/next_api_changes/README.rst.txt" rel="nofollow">Show Source</a></li> </ul> </div> <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <div class="searchformwrapper"> <form class="search" action="../../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <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> <div class="footer"> © Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2017 The Matplotlib development team. Last updated on Mar 06, 2018. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.1. </div> </body> <footer> </footer> </html>