Skip to content

Commit

Permalink
Adding type annotation to signature of triangulation_isosig.
Browse files Browse the repository at this point in the history
  • Loading branch information
unhyperbolic committed Jul 25, 2024
1 parent b73e2d1 commit 14b4660
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
8 changes: 4 additions & 4 deletions cython/core/triangulation.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -2886,10 +2886,10 @@ cdef class Triangulation():
return get_num_fake_cusps(self.c_triangulation) > 0

def triangulation_isosig(self,
decorated=True,
ignore_cusp_ordering = False,
ignore_curve_orientations = False,
ignore_orientation = True) -> str:
decorated : bool = True,
ignore_cusp_ordering : bool = False,
ignore_curve_orientations : bool = False,
ignore_orientation : bool = True) -> str:
"""
Returns a compact text representation of the triangulation, called a
"decorated isomorphism signature"
Expand Down
3 changes: 3 additions & 0 deletions doc_src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -210,3 +210,6 @@ def setup(app):

# Output file base name for HTML help builder.
htmlhelp_basename = 'SnapPydoc'

# This adds the type annotations to the params section instead of the signature.
# autodoc_typehints = "description"

0 comments on commit 14b4660

Please sign in to comment.