Skip to content

Commit

Permalink
src/sage/geometry/cone_critical_angles.py: add another "internal" war…
Browse files Browse the repository at this point in the history
…ning

The existing warning about this module being internal is easy to
miss. This one should appear in bright red at the top of the module
documentation.
  • Loading branch information
orlitzky committed May 6, 2024
1 parent ad7c29c commit 30464f7
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/sage/geometry/cone_critical_angles.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
r"""
Find maximal angles between polyhedral convex cones
.. WARNING::
This module is considered internal and its contents are subject to
change at any time without (deprecation) warning. The stable
interface is
:meth:`sage.geometry.cone.ConvexRationalPolyhedralCone.max_angle`.
Finding the maximal (or equivalently, the minimal) angle between two
polyhedral convex cones is a hard nonconvex optimization problem. The
problem for a single cone was introduced in [IS2005]_, and was later
Expand Down

0 comments on commit 30464f7

Please sign in to comment.