Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation of integral_points #39414

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Fix documentation of integral_points #39414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3bac54
Try to fix documentation of integral_points
user202729 Jan 31, 2025
ea08771
Add a docstring for explanation
user202729 Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/doc/en/reference/discrete_geometry/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,11 @@ Helper functions

sage/geometry/fan_isomorphism
sage/geometry/hasse_diagram
sage/geometry/integral_points
sage/geometry/integral_points_generic_dense
sage/geometry/hyperplane_arrangement/check_freeness

..
The integral_points_generic_dense entry above should be sage/geometry/integral_points
but Sphinx does not handle the Python file containing only import very well
.. include:: ../footer.txt
9 changes: 9 additions & 0 deletions src/sage/geometry/integral_points_generic_dense.pyx
View file
Open in desktop
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
Loading