Skip to content

Commit

Permalink
Fix types of a number of ManSections in the reference manual
Browse files Browse the repository at this point in the history
These were detected using `make check-manuals`.
  • Loading branch information
Alexander Konovalov authored and alex-konovalov committed Dec 14, 2018
1 parent 82bbc01 commit 9c7c58f
Show file tree
Hide file tree
Showing 6 changed files with 50 additions and 50 deletions.
4 changes: 2 additions & 2 deletions doc/ref/floats.xml
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Floating-point numbers may be created using the single function
<Ref Func="Float"/>, which accepts as arguments rational, string,
or floating-point numbers. Floating-point numbers may
also be created, in any floating-point representation, using
<Ref Func="NewFloat"/> as in <C>NewFloat(IsIEEE754FloatRep,355/113)</C>,
<Ref Constr="NewFloat"/> as in <C>NewFloat(IsIEEE754FloatRep,355/113)</C>,
by supplying the category filter of the desired new floating-point number;
or using <Ref Func="MakeFloat"/> as in <C>NewFloat(1.0,355/113)</C>,
by supplying a sample floating-point number.
Expand Down Expand Up @@ -235,7 +235,7 @@ Complex arithmetic may be implemented in packages, and is present in
<Package>float</Package>. Complex numbers are treated as usual
numbers; they may be input with an extra "i" as in
<C>-0.5+0.866i</C>. They may also be created using <Ref
Oper="NewFloat"/> with three arguments: the float filter, the real
Constr="NewFloat"/> with three arguments: the float filter, the real
part, and the imaginary part.
<P/>

Expand Down
84 changes: 42 additions & 42 deletions lib/float.gd
Original file line number Diff line number Diff line change
Expand Up @@ -51,49 +51,49 @@ end);
## <#GAPDoc Label="Float-Math-Commands">
## <ManSection>
## <Heading>Standard mathematical operations</Heading>
## <Oper Name="Cos" Arg="f"/>
## <Oper Name="Sin" Arg="f"/>
## <Oper Name="Tan" Arg="f"/>
## <Oper Name="Sec" Arg="f"/>
## <Oper Name="Csc" Arg="f"/>
## <Oper Name="Cot" Arg="f"/>
## <Oper Name="Asin" Arg="f"/>
## <Oper Name="Acos" Arg="f"/>
## <Oper Name="Atan" Arg="f"/>
## <Oper Name="Cosh" Arg="f"/>
## <Oper Name="Sinh" Arg="f"/>
## <Oper Name="Tanh" Arg="f"/>
## <Oper Name="Sech" Arg="f"/>
## <Oper Name="Csch" Arg="f"/>
## <Oper Name="Coth" Arg="f"/>
## <Oper Name="Asinh" Arg="f"/>
## <Oper Name="Acosh" Arg="f"/>
## <Oper Name="Atanh" Arg="f"/>
## <Attr Name="Cos" Arg="f"/>
## <Attr Name="Sin" Arg="f"/>
## <Attr Name="Tan" Arg="f"/>
## <Attr Name="Sec" Arg="f"/>
## <Attr Name="Csc" Arg="f"/>
## <Attr Name="Cot" Arg="f"/>
## <Attr Name="Asin" Arg="f"/>
## <Attr Name="Acos" Arg="f"/>
## <Attr Name="Atan" Arg="f"/>
## <Attr Name="Cosh" Arg="f"/>
## <Attr Name="Sinh" Arg="f"/>
## <Attr Name="Tanh" Arg="f"/>
## <Attr Name="Sech" Arg="f"/>
## <Attr Name="Csch" Arg="f"/>
## <Attr Name="Coth" Arg="f"/>
## <Attr Name="Asinh" Arg="f"/>
## <Attr Name="Acosh" Arg="f"/>
## <Attr Name="Atanh" Arg="f"/>
## <Oper Name="Log" Arg="f"/>
## <Oper Name="Log2" Arg="f"/>
## <Oper Name="Log10" Arg="f"/>
## <Oper Name="Log1p" Arg="f"/>
## <Oper Name="Exp" Arg="f"/>
## <Oper Name="Exp2" Arg="f"/>
## <Oper Name="Exp10" Arg="f"/>
## <Oper Name="Expm1" Arg="f"/>
## <Oper Name="CubeRoot" Arg="f"/>
## <Oper Name="Square" Arg="f"/>
## <Oper Name="Ceil" Arg="f"/>
## <Oper Name="Floor" Arg="f"/>
## <Oper Name="Round" Arg="f"/>
## <Oper Name="Trunc" Arg="f"/>
## <Attr Name="Log2" Arg="f"/>
## <Attr Name="Log10" Arg="f"/>
## <Attr Name="Log1p" Arg="f"/>
## <Attr Name="Exp" Arg="f"/>
## <Attr Name="Exp2" Arg="f"/>
## <Attr Name="Exp10" Arg="f"/>
## <Attr Name="Expm1" Arg="f"/>
## <Attr Name="CubeRoot" Arg="f"/>
## <Attr Name="Square" Arg="f"/>
## <Attr Name="Ceil" Arg="f"/>
## <Attr Name="Floor" Arg="f"/>
## <Attr Name="Round" Arg="f"/>
## <Attr Name="Trunc" Arg="f"/>
## <Oper Name="Atan2" Arg="y x"/>
## <Oper Name="FrExp" Arg="f"/>
## <Attr Name="FrExp" Arg="f"/>
## <Oper Name="LdExp" Arg="f exp"/>
## <Oper Name="AbsoluteValue" Arg="f" Label="for floats"/>
## <Oper Name="Norm" Arg="f" Label="for floats"/>
## <Attr Name="AbsoluteValue" Arg="f" Label="for floats"/>
## <Attr Name="Norm" Arg="f" Label="for floats"/>
## <Oper Name="Hypothenuse" Arg="x y"/>
## <Oper Name="Frac" Arg="f"/>
## <Oper Name="SinCos" Arg="f"/>
## <Oper Name="Erf" Arg="f"/>
## <Oper Name="Zeta" Arg="f"/>
## <Oper Name="Gamma" Arg="f"/>
## <Attr Name="Frac" Arg="f"/>
## <Attr Name="SinCos" Arg="f"/>
## <Attr Name="Erf" Arg="f"/>
## <Attr Name="Zeta" Arg="f"/>
## <Attr Name="Gamma" Arg="f"/>
## <Description>
## Standard math functions.
## </Description>
Expand Down Expand Up @@ -273,7 +273,7 @@ DeclareGlobalFunction("RootsFloat");
## </ManSection>
## <ManSection>
## <Attr Name="AbsoluteDiameter" Arg="x"/>
## <Attr Name="Diameter" Arg="x"/>
## <Oper Name="Diameter" Arg="x"/>
## <Description>
## Returns the absolute diameter of the interval <A>x</A>, namely
## the difference <C>Sup(x)-Inf(x)</C>.
Expand Down Expand Up @@ -341,7 +341,7 @@ DeclareOperation("BisectInterval", [IsFloatInterval]);
## <ManSection>
## <Heading>Float creators</Heading>
## <Func Name="Float" Arg="obj"/>
## <Oper Name="NewFloat" Arg="filter, obj"/>
## <Constr Name="NewFloat" Arg="filter, obj"/>
## <Oper Name="MakeFloat" Arg="sample obj, obj"/>
## <Returns>A new floating-point number, based on <A>obj</A></Returns>
## <Description>
Expand Down Expand Up @@ -388,7 +388,7 @@ DeclareOperation("BisectInterval", [IsFloatInterval]);
## </ManSection>
##
## <ManSection>
## <Attr Name="Cyc" Arg="f [degree]" Label="for floats"/>
## <Oper Name="Cyc" Arg="f [degree]" Label="for floats"/>
## <Returns>A cyclotomic approximation to <A>f</A></Returns>
## <Description>
## This command constructs a cyclotomic approximation to the
Expand Down
2 changes: 1 addition & 1 deletion lib/grp.gd
Original file line number Diff line number Diff line change
Expand Up @@ -869,7 +869,7 @@ DeclareAttribute( "AbelianRank", IsGroup );
##
## <#GAPDoc Label="IsInfiniteAbelianizationGroup:grp">
## <ManSection>
## <Attr Name="IsInfiniteAbelianizationGroup" Arg='G'/>
## <Prop Name="IsInfiniteAbelianizationGroup" Arg='G'/>
##
## <Description>
## <Index Subkey="for groups" Key="IsInfiniteAbelianizationGroup">
Expand Down
6 changes: 3 additions & 3 deletions lib/grplatt.gd
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ DeclareGlobalFunction("LowLayerSubgroups");
##
## <#GAPDoc Label="ContainedConjugates">
## <ManSection>
## <Func Name="ContainedConjugates" Arg='G, A, B'/>
## <Oper Name="ContainedConjugates" Arg='G, A, B'/>
##
## <Description>
## For <M>A,B \leq G</M> this operation returns representatives of the <A>A</A>
Expand All @@ -478,7 +478,7 @@ DeclareSynonym("EmbeddedConjugates",ContainedConjugates);
##
## <#GAPDoc Label="ContainingConjugates">
## <ManSection>
## <Func Name="ContainingConjugates" Arg='G, A, B'/>
## <Oper Name="ContainingConjugates" Arg='G, A, B'/>
##
## <Description>
## For <M>A,B \leq G</M> this operation returns all <A>G</A> conjugates of <A>A</A>
Expand All @@ -503,7 +503,7 @@ DeclareSynonym("EmbeddingConjugates",ContainingConjugates);
##
## <#GAPDoc Label="MinimalFaithfulPermutationDegree">
## <ManSection>
## <Func Name="MinimalFaithfulPermutationDegree" Arg='G'/>
## <Oper Name="MinimalFaithfulPermutationDegree" Arg='G'/>
##
## <Description>
## For a finite group <A>G</A> this operation calculates the least
Expand Down
2 changes: 1 addition & 1 deletion lib/matobj2.gd
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ DeclareGlobalFunction( "ConcatenationOfVectors" );

## <#GAPDoc Label="MatObj_ExtractSubVector">
## <ManSection>
## <Func Arg="V,l" Name="ExtractSubVector" Label="for IsVectorObj,IsList"/>
## <Oper Arg="V,l" Name="ExtractSubVector" Label="for IsVectorObj,IsList"/>
## <Returns>a vector object</Returns>
## <Description>
## Returns a new vector containing the entries of <A>V</A>
Expand Down
2 changes: 1 addition & 1 deletion lib/matrix.gd
Original file line number Diff line number Diff line change
Expand Up @@ -2075,7 +2075,7 @@ DeclareOperation("BaseField",[IsObject]);
##
## <#GAPDoc Label="SimplexMethod">
## <ManSection>
## <Oper Name="SimplexMethod" Arg='A,b,c'/>
## <Func Name="SimplexMethod" Arg='A,b,c'/>
##
## <Description>
## Find a rational vector <A>x</A> that maximizes <M><A>x</A>\cdot<A>c</A></M>, subject
Expand Down

0 comments on commit 9c7c58f

Please sign in to comment.