Merge pull request #91 from lukelbd/rc-cleanup-fixes

Clean up rc_configurator

Author: lukelbd

CHANGELOG.rst

@@ -19,10 +19,6 @@ ProPlot v0.5.0 (2020-##-##)
 ===========================
 .. rubric:: Deprecated
 
-- Remove ``subplots.innerspace``, ``subplots.titlespace``,
-  ``subplots.xlabspace``, and ``subplots.ylabspace`` spacing arguments,
-  automatically calculate default non-tight spacing using `~proplot.subplots._get_space`
-  based on current tick lengths, label sizes, etc.
 - Rename `basemap_defaults` to `~proplot.projs.basemap_kwargs` and `cartopy_projs`
   to `~proplot.projs.cartopy_names` (:commit:`431a06ce`).
 
@@ -32,22 +28,12 @@ ProPlot v0.5.0 (2020-##-##)
   *or* `~proplot.subplots.subplots` (:pr:`50`). This is a major improvement!
 - `~proplot.subplots.GridSpec` now accepts physical units, rather than having
   `~proplot.subplots.subplots` handle the units (:pr:`50`).
-- Add `xlinewidth`, `ylinewidth`, `xgridcolor`, `ygridcolor` keyword
-  args to `~proplot.axes.XYAxes.format` (:pr:`50`).
 - Allow "hanging" twin *x* and *y* axes as members of the `~proplot.subplots.EdgeStack`
   container. Arbitrarily many siblings are now permitted.
 - Use `~proplot.subplots.GeometrySolver` for calculating various automatic layout
   stuff instead of having 1000 hidden `~proplot.subplots.Figure` methods (:pr:`50`).
 - Use `~proplot.subplots.EdgeStack` class for handling
   stacks of colorbars, legends, and text (:pr:`50`).
-- `~proplot.rctools.rc` `~proplot.rctools.rc_configurator.__getitem__` always
-  returns the setting; "caching" can only be used *explicitly* by passing ``cache=True`` to
-  `~proplot.rctools.rc_configurator.get`, `~proplot.rctools.rc_configurator.fill`, and
-  `~proplot.rctools.rc_configurator.category` (:pr:`50`).
-
-.. rubric:: Bug fixes
-
-- Fix `~proplot.rctools.rc_configurator.context` fatal bug (:issue:`80`).
 
 .. rubric:: Internals
 
@@ -56,23 +42,33 @@ ProPlot v0.5.0 (2020-##-##)
 - Panels, colorbars, and legends are now members of `~proplot.subplots.EdgeStack`
   stacks rather than getting inserted directly into
   the main `~proplot.subplots.GridSpec` (:pr:`50`).
-- Define `~proplot.rctools.rc` default values with inline dictionaries rather than
-  with a default ``.proplotrc`` file, change the auto-generated user ``.proplotrc``
-  (:pr:`50`).
 
 ProPlot v0.4.0 (2020-##-##)
 ===========================
 .. rubric:: Deprecated
 
 - Remove redundant `~proplot.rctools.use_fonts`, use ``rcParams['sans-serif']``
   precedence instead (:pr:`95`).
-- `~proplot.axes.Axes.dualx` and `~proplot.axes.Axes.dualx` no longer accept "scale-spec" arguments, must be a function, two functions, or an axis scale instance (:pr:`96`).
+- `~proplot.axes.Axes.dualx` and `~proplot.axes.Axes.dualx` no longer accept "scale-spec" arguments.
+  Must be a function, two functions, or an axis scale instance (:pr:`96`).
+- Remove ``subplots.innerspace``, ``subplots.titlespace``,
+  ``subplots.xlabspace``, and ``subplots.ylabspace`` spacing arguments,
+  automatically calculate default non-tight spacing using `~proplot.subplots._get_space`
+  based on current tick lengths, label sizes, etc.
 
 .. rubric:: Features
 
 - Add Fira Math as DejaVu Sans-alternative (:pr:`95`). Has complete set of math characters.
 - Add TeX Gyre Heros as Helvetica-alternative (:pr:`95`). This is the new open-source default font.
-- Add `~proplot.subplots.Figure` ``fallback_to_cm`` kwarg. This is used by `~proplot.styletools.show_fonts` to show dummy glyphs to clearly illustrate when fonts are missing characters, but preserve graceful fallback for end user.
+- Add `xlinewidth`, `ylinewidth`, `xgridcolor`, `ygridcolor` keyword
+  args to `~proplot.axes.XYAxes.format` (:pr:`95`).
+- Add `~proplot.subplots.Figure` ``fallback_to_cm`` kwarg. This is used by
+  `~proplot.styletools.show_fonts` to show dummy glyphs to clearly illustrate when fonts are
+  missing characters, but preserve graceful fallback for end user.
+- `~proplot.rctools.rc` `~proplot.rctools.rc_configurator.__getitem__` always
+  returns the setting. To get context block-restricted settings, you must explicitly pass
+  ``context=True`` to `~proplot.rctools.rc_configurator.get`, `~proplot.rctools.rc_configurator.fill`,
+  or `~proplot.rctools.rc_configurator.category` (:pr:`91`).
 
 .. rubric:: Bug fixes
 
@@ -84,7 +80,16 @@ ProPlot v0.4.0 (2020-##-##)
 .. rubric:: Documentation
 
 - Imperative mood for docstring summaries (:pr:`92`).
-- Fix `~proplot.styletools.show_cycles` bug (:pr:`90`) and show cycles using colorbars rather than lines.
+- Fix `~proplot.styletools.show_cycles` bug (:pr:`90`) and show cycles using colorbars
+  rather than lines.
+
+.. rubric:: Internals
+
+- Define `~proplot.rctools.rc` default values with inline dictionaries rather than
+  with a default ``.proplotrc`` file, change the auto-generated user ``.proplotrc``
+  (:pr:`91`).
+- Remove useless `panel_kw` keyword arg from `~proplot.wrappers.legend_wrapper` and
+  `~proplot.wrappers.colorbar_wrapper` (:pr:`91`).
 
 ProPlot v0.3.1 (2019-12-16)
 ===========================

INSTALL.rst

@@ -1,24 +1,18 @@
 Installation
 ============
 
-ProPlot can be installed with `pip <https://pypi.org>`__ or `conda <https://anaconda-project.readthedocs.io/en/latest/>`__:
+ProPlot is published on `PyPi <https://pypi.org/project/proplot/>`__ and `conda-forge <https://conda-forge.org>`__. It can be installed with ``pip`` or ``conda`` as follows:
 
 .. code-block:: bash
 
    pip install proplot
-
-.. code-block:: bash
-
    conda install -c conda-forge proplot
 
-An existing installation of ProPlot can be upgraded to the latest version with:
+Likewise, an existing installation of ProPlot can be upgraded to the latest version with:
 
 .. code-block:: bash
 
    pip install --upgrade proplot
-
-.. code-block:: bash
-
    conda upgrade proplot
 
 

README.rst

@@ -8,27 +8,20 @@ A comprehensive, easy-to-use `matplotlib <https://matplotlib.org/>`__ wrapper fo
 Installation
 ============
 
-ProPlot can be installed with `pip <https://pypi.org>`__ or `conda <https://anaconda-project.readthedocs.io/en/latest/>`__:
+ProPlot is published on `PyPi <https://pypi.org/project/proplot/>`__ and `conda-forge <https://conda-forge.org>`__. It can be installed with ``pip`` or ``conda`` as follows:
 
 .. code-block:: bash
 
    pip install proplot
-
-.. code-block:: bash
-
    conda install -c conda-forge proplot
 
-An existing installation of ProPlot can be upgraded to the latest version with:
+Likewise, an existing installation of ProPlot can be upgraded to the latest version with:
 
 .. code-block:: bash
 
    pip install --upgrade proplot
-
-.. code-block:: bash
-
    conda upgrade proplot
 
-
 If you used ``pip install git+https://github.com/lukelbd/proplot.git`` to install ProPlot before it was released on PyPi, you may need to run ``pip uninstall proplot`` before upgrading.
 To install a development version of ProPlot, you can use this same method, or clone the repository and run ``pip install --upgrade .`` inside the ``proplot`` folder.