Polyhedron_base._affine_hull_name_latex_name: Add docstring

sagemath · May 16, 2021 · 8af2c71 · 8af2c71
1 parent 87a2bea
commit 8af2c71
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/src/sage/geometry/polyhedron/base.py b/src/sage/geometry/polyhedron/base.py
@@ -10631,6 +10631,18 @@ def affine_hull_manifold(self, name=None, latex_name=None, start_index=0, ambien
         return H
 
     def _affine_hull_name_latex_name(self, name=None, latex_name=None):
+        """
+        Return the default name of the affine hull.
+
+        EXAMPLES::
+
+            sage: polytopes.cube()._affine_hull_name_latex_name('C', r'\square')
+            ('aff_C', '\\mathop{\\mathrm{aff}}(\\square)')
+
+            sage: Polyhedron(vertices=[[0, 1], [1, 0]])._affine_hull_name_latex_name()
+            ('aff_P', '\\mathop{\\mathrm{aff}}(P)')
+        """
+
         if name is None:
             name = 'P'
         if latex_name is None: