Skip to content

Commit

Permalink
Add a docstring for explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
user202729 committed Jan 31, 2025
1 parent f3bac54 commit ea08771
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/sage/geometry/integral_points_generic_dense.pyx
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
# cython: wraparound=False, boundscheck=False
r"""
Cython helper methods to compute integral points in polyhedra
Note that while the URL of this documentation page ends with
``integral_points_generic_dense``, this is merely to allow Sphinx to generate
the documentation automatically. Imports should be from
:mod:`sage.geometry.integral_points`, as can be seen in the examples below.
Furthermore, not all functions are exported to the public interface.
"""

from sage.modules.vector_integer_dense cimport Vector_integer_dense as VectorClass
from sage.matrix.matrix_dense cimport Matrix_dense as MatrixClass
Expand Down

0 comments on commit ea08771

Please sign in to comment.