Removing Surface alias for Triangle. (#252)

This type was deprecated in the 2020.1.14 release.
dhermes · Mar 1, 2021 · 40d3c22 · 40d3c22
1 parent c802b0c
commit 40d3c22
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 89 deletions.
diff --git a/docs/releases/latest.rst b/docs/releases/latest.rst
@@ -6,6 +6,15 @@ Latest Release (``2021.2.13.dev1``)
 Python Changes
 --------------
 
+Breaking Changes
+~~~~~~~~~~~~~~~~
+
+-  Removing ``Surface`` alias for the ``Triangle``
+   `type <https://bezier.readthedocs.io/en/2021.2.13.dev1/python/reference/bezier.triangle.html#bezier.triangle.Triangle>`__
+   (`#252 <https://github.com/dhermes/bezier/pull/252>`__). The ``Surface``
+   type was deprecated (and converted to an alias) in the ``2020.1.14``
+   release.
+
 Additive Changes
 ~~~~~~~~~~~~~~~~
 

diff --git a/scripts/rewrite_package_rst.py b/scripts/rewrite_package_rst.py
@@ -24,7 +24,7 @@
     import bezier
 except ImportError:
     bezier = None
-SPECIAL_MEMBERS = ("__author__", "__version__", "Surface")
+SPECIAL_MEMBERS = ("__author__", "__version__")
 UNDOCUMENTED_SPECIAL_MEMBERS = ("__author__",)
 EXPECTED = """\
 bezier package

diff --git a/src/python/bezier/__init__.py b/src/python/bezier/__init__.py
@@ -20,14 +20,11 @@
 
 .. |eacute| unicode:: U+000E9 .. LATIN SMALL LETTER E WITH ACUTE
    :trim:
-
-.. autoclass:: Surface
 """
 
 # NOTE: ``__config__`` **must** be the first import because it (may)
 #       modify the search path used to locate shared libraries.
 from bezier import __config__
-from bezier._legacy import Surface
 from bezier.curve import Curve
 from bezier.curved_polygon import CurvedPolygon
 from bezier.hazmat.helpers import UnsupportedDegree
@@ -52,7 +49,6 @@
     "__version__",
     "Curve",
     "CurvedPolygon",
-    "Surface",
     "Triangle",
     "UnsupportedDegree",
 ]
diff --git a/src/python/bezier/_legacy.py b/src/python/bezier/_legacy.py
diff --git a/tests/unit/test__legacy.py b/tests/unit/test__legacy.py