Merge pull request #5371 from QuLogic/transformedpatchpath-doc

DOC: Add what's new entry for TransformedPatchPath.
matplotlib · Oct 31, 2015 · 38782e3 · 38782e3
2 parents aaa34e0 + afe4312
commit 38782e3
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/doc/users/whats_new/2015-10-31_TransformedPatchPath.rst b/doc/users/whats_new/2015-10-31_TransformedPatchPath.rst
@@ -0,0 +1,13 @@
+New TransformedPatchPath caching object
+---------------------------------------
+
+A newly added :class:`~matplotlib.transforms.TransformedPatchPath` provides a
+means to transform a :class:`~matplotlib.patches.Patch` into a
+:class:`~matplotlib.path.Path` via a :class:`~matplotlib.transforms.Transform`
+while caching the resulting path. If neither the patch nor the transform have
+changed, a cached copy of the path is returned.
+
+This class differs from the older
+:class:`~matplotlib.transforms.TransformedPath` in that it is able to refresh
+itself based on the underlying patch while the older class uses an immutable
+path.