API: rename registry module to global_figures

Author: tacaswell

docs/source/api.rst

@@ -96,7 +96,7 @@ Globally managed
 ----------------
 
 
-.. automodule:: mpl_gui.registry
+.. automodule:: mpl_gui.global_figures
    :no-undoc-members:
 
 
@@ -108,9 +108,9 @@ Create Figures and Axes
    :toctree: _as_gen
    :nosignatures:
 
-   mpl_gui.registry.figure
-   mpl_gui.registry.subplots
-   mpl_gui.registry.subplot_mosaic
+   mpl_gui.global_figures.figure
+   mpl_gui.global_figures.subplots
+   mpl_gui.global_figures.subplot_mosaic
 
 
 Access managed figures
@@ -121,7 +121,7 @@ Access managed figures
    :toctree: _as_gen
    :nosignatures:
 
-   mpl_gui.registry.by_label
+   mpl_gui.global_figures.by_label
 
 
 Show and close managed Figures
@@ -134,10 +134,10 @@ Show and close managed Figures
 
 
 
-   mpl_gui.registry.show
-   mpl_gui.registry.show_all
-   mpl_gui.registry.close_all
-   mpl_gui.registry.close
+   mpl_gui.global_figures.show
+   mpl_gui.global_figures.show_all
+   mpl_gui.global_figures.close_all
+   mpl_gui.global_figures.close
 
 
 Interactivity
@@ -148,6 +148,6 @@ Interactivity
    :nosignatures:
 
 
-   mpl_gui.registry.ion
-   mpl_gui.registry.ioff
-   mpl_gui.registry.is_interactive
+   mpl_gui.global_figures.ion
+   mpl_gui.global_figures.ioff
+   mpl_gui.global_figures.is_interactive

docs/source/index.rst

@@ -50,9 +50,9 @@ Globally Managed Figures
 ========================
 
 
-The `mpl_gui.registry` module provides a direct analogy to the
+The `mpl_gui.global_figures` module provides a direct analogy to the
 `matplotlib.pyplot` behavior of having a global registry of figures.  Thus, any
-figures created via the functions in `.registry` will remain alive until they
+figures created via the functions in `.global_figures` will remain alive until they
 have been cleared from the registry (and the user has dropped all other
 references).  While it can be convenient, it carries with it the risk inherent
 in any use of global state.
@@ -61,23 +61,23 @@ The `matplotlib.pyplot` API related to figure creation, showing, and closing is
 
 ::
 
-   import mpl_gui.registry as reg
+   import mpl_gui.global_figures as gfigs
 
-   fig = reg.figure()
-   fig, ax = reg.subplots()
-   fig, axd = reg.subplot_mosaic('AA\nCD')
+   fig = gfigs.figure()
+   fig, ax = gfigs.subplots()
+   fig, axd = gfigs.subplot_mosaic('AA\nCD')
 
-   reg.show(block=True)                # blocks until all figures are closed
-   reg.show(block=True, timeout=1000)  # blocks for up to 1s or all figures are closed
-   reg.show(block=False)               # does not block
-   reg.show()                          # depends on if in "interacitve mode"
+   gfigs.show(block=True)                # blocks until all figures are closed
+   gfigs.show(block=True, timeout=1000)  # blocks for up to 1s or all figures are closed
+   gfigs.show(block=False)               # does not block
+   gfigs.show()                          # depends on if in "interacitve mode"
 
-   reg.ion()                           # turn on interactive mode
-   reg.ioff()                          # turn off interactive mode
-   reg.is_interactive()                # query interactive state
+   gfigs.ion()                           # turn on interactive mode
+   gfigs.ioff()                          # turn off interactive mode
+   gfigs.is_interactive()                # query interactive state
 
-   reg.close('all')                    # close all open figures
-   reg.close(fig)                      # close a particular figure
+   gfigs.close('all')                    # close all open figures
+   gfigs.close(fig)                      # close a particular figure
 
 
 
@@ -146,7 +146,7 @@ This will create 3 figures and block on ``__exit__``.  The blocking
 behavior depends on `~mpl_gui.is_interactive()` (and follow the behavior of
 `.display` and `.FigureRegistry.show` can explicitly controlled via the *block* keyword argument).
 
-The `.registry` module is implemented by having a singleton `.FigureRegistry`
+The `.global_figures` module is implemented by having a singleton `.FigureRegistry`
 at the module level.