Docstrings for examples/requirements

Author: ksunden

Diff for: examples/scatter_with_custom_axes.py

@@ -1,3 +1,17 @@
+"""
+=========================================
+An simple scatter plot using `ax.scatter`
+=========================================
+
+This is a quick comparison between the current Matplotlib `scatter` and
+the version in :file:`data_prototype/axes.py`, which uses data containers
+and a conversion pipeline.
+
+This is here to show what does work and what does not work with the current
+implementation of container-based artist drawing.
+"""
+
+
 import data_prototype.axes  # side-effect registers projection # noqa
 
 import matplotlib.pyplot as plt

Diff for: examples/units.py

@@ -1,10 +1,9 @@
 """
-==================================================
-An simple scatter plot using PathCollectionWrapper
-==================================================
+===========================================
+Using pint units with PathCollectionWrapper
+===========================================
 
-A quick scatter plot using :class:`.containers.ArrayContainer` and
-:class:`.wrappers.PathCollectionWrapper`.
+Using third party units functionality in conjunction with Matplotlib Axes
 """
 import numpy as np
 
@@ -35,6 +34,10 @@
 fig, ax = plt.subplots()
 ax.set_xlim(-0.5, 7)
 ax.set_ylim(0, 5)
+
+# DelayedConversionNode is used to identify the keys which undergo unit transformations
+# The actual method which does conversions in this example is added by the
+# `Axis`/`Axes`, but `PathCollectionWrapper` does not natively interact with the units.
 xconv = DelayedConversionNode.from_keys(("x",), converter_key="xunits")
 yconv = DelayedConversionNode.from_keys(("y",), converter_key="yunits")
 lw = PathCollectionWrapper(cont, [xconv, yconv], offset_transform=ax.transData)

Diff for: requirements-doc.txt

@@ -7,3 +7,4 @@ sphinx-copybutton
 sphinx-gallery
 ipython
 scikit-image
+pint