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.

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

Added synonym SimplicialGon for SimplicialUmbrella #289

Merged
merged 1 commit into from
Sep 18, 2024
Merged
Changes from all commits
Commits
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
30 changes: 15 additions & 15 deletions gap/Library/library.gd
Original file line number Diff line number Diff line change
Expand Up @@ -433,13 +433,14 @@ DeclareOperation( "Icosahedron", [] );
DeclareOperation( "JanusHead", [] );



#! @BeginGroup SimplicialUmbrella
#! @Description
#! Return a simplicial surface consisting of one closed umbrella-path
#! with <A>nrFaces</A> triangles. The labels are assigned according
#! to the following illustration, in which <M>n</M> is <A>nrFaces</A>:

#! <ManSection Label="SimplicialUmbrella">
#! <Oper Name="SimplicialUmbrella" Arg="nrFaces" Label="for IsPosInt"/>
#! <Filt Name="SimplicialGon" Arg="nrFaces" Type="operation"/>
#! <Returns><K>a simplicial surface</K></Returns>
#! <Description>
#! Return a simplicial surface consisting of one closed umbrella-path
#! with <A>nrFaces</A> triangles. The labels are assigned according
#! to the following illustration, in which <M>n</M> is <A>nrFaces</A>:
#! <Alt Only="HTML">
#! &lt;br>&lt;img src='./images/_Wrapper_library-1-1.svg'> &lt;/img> &lt;br>
#! </Alt>
Expand All @@ -450,7 +451,7 @@ DeclareOperation( "JanusHead", [] );
#! </Alt>
#! <Alt Only = "Text">
#! Image omitted in terminal text
#! </Alt>
#! </Alt>
#!
#! @ExampleSession
#! gap> umb4 := SimplicialUmbrella(4);
Expand All @@ -468,13 +469,12 @@ DeclareOperation( "JanusHead", [] );
#! [ [ 1, 3 ], [ 2, 3 ], [ 1, 2 ], [ 1, 2 ] ]
#! gap> EdgesOfFaces(umb2);
#! [ [ 1, 2, 3 ], [ 1, 2, 4 ] ]
#! @EndExampleSession
#!
#!
#! @Returns a simplicial surface
#! @Arguments nrFaces
DeclareOperation( "SimplicialUmbrella", [ IsPosInt ] );
#! @EndGroup
#! @EndExampleSession
#! </Description>
#! </ManSection>
# here no AutoDoc documentation since synonyms can't be handled automatically
DeclareOperation("SimplicialUmbrella", [ IsPosInt ] );
DeclareSynonym("SimplicialGon", SimplicialUmbrella);

#! @BeginGroup SimplicialOpenGeodesic
#! @Description
Expand Down