<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>Adding API change notes &#8212; Matplotlib 3.3.2 documentation</title>

<link rel="stylesheet" href="../../_static/mpl.css?3.3.2" 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/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" />

<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 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.3.2 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="Behaviour changes" href="behaviour.html" />

<link rel="prev" title="Changes for 0.40" href="../prev_api_changes/api_changes_0.40.html" />

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

<link rel="canonical" href="https://matplotlib.org/3.3.4/api/api_changes_3.4/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.3.2). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</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.3.2</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="behaviour.html" title="Behaviour changes"

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>|&nbsp;</li>

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

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

<li class="nav-item nav-item-2"><a href="../api_changes.html" accesskey="U">API Changes</a> &#187;</li>

<li class="nav-item nav-item-this"><a href="">Adding API change notes</a></li>

</ul>

</div>

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

<div class="sphinxsidebarwrapper"><div class="relations">

<h3>Related Topics</h3>

<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="behaviour.html" title="next chapter">Behaviour changes</a></li>

</ul></li>

</ul></li>

</ul></li>

<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/api_changes_3.4/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>API change notes for future releases are collected in the most recent directory

<code class="file docutils literal notranslate"><span class="pre">api_changes_X.Y</span></code>. They are divided into four categories:</p>

<ul class="simple">

<li><strong>Deprecations</strong>: Announcements of future changes. Typically, these will

raise a deprecation warning and users of this API should change their code

to stay compatible with future releases of Matplotlib. If possible, state

what should be used instead.</li>

<li><strong>Removals</strong>: Parts of the API that got removed. If possible, state what

should be used instead.</li>

<li><strong>Behaviour changes</strong>: API that stays valid but will yield a different

result.</li>

<li><strong>Development changes</strong>: Changes to the build process, dependencies, etc.</li>

<p>Please place new entries in the respective files in this directory. Typically,

each change will get its own section, but you may also amend existing sections

when suitable. The overall goal is a comprehensible documentation of the

changes.</p>

<p>A typical entry could look like this:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>Locators

~~~~~~~~

The unused `Locator.autoscale()` method is deprecated (pass the axis

limits to `Locator.view_limits()` instead).

</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 - 2020 The Matplotlib development team.

<br />

Last updated on Sep 15, 2020.

Created using

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

Doc version 3.3.2.

</div>

</body>