Skip to content

Commit

Permalink
Merge pull request #1823 from fchapoton/typos_in_the_doc
Browse files Browse the repository at this point in the history
fix typos in the doc
  • Loading branch information
DanGrayson authored Jan 18, 2021
2 parents 0bac21b + 33f57e5 commit a510fda
Show file tree
Hide file tree
Showing 35 changed files with 55 additions and 55 deletions.
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Macaulay2Doc/M2-Singular-Book.m2
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ document {
Key => "Singular Book 1.1.8",
Headline => "computation in fields",
SUBSECTION "Computation over ZZ and QQ",
"In Macaulay2, Integers are arbitary precision. The ring of integers is denoted ZZ.",
"In Macaulay2, Integers are arbitrary precision. The ring of integers is denoted ZZ.",
EXAMPLE {
"123456789^5",
"matrix{{123456789^5}}",
Expand Down
10 changes: 5 additions & 5 deletions M2/Macaulay2/packages/Macaulay2Doc/changes.m2
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ document {
LI { "The option ", TO Boxes, " of ", TO netList,
" has been made more flexible to allow customization of the box;",
" it now accepts as input a pair of lists of rows and columns." },
LI { "A brief documentation of various types of objects can be viewed usin ", TO (symbol?, Symbol), "." },
LI { "A brief documentation of various types of objects can be viewed using ", TO (symbol?, Symbol), "." },
LI { "The ", TO document, " function now accepts three new options: ", TO "Acknowledgement", ", ",
TO "Contributors", ", and ", TO "References", ". The content of each will appear under a subsection
of the same name in the documentation. Moreover, ", TO "SimpleDoc :: document(String)", " is now a synonym for ",
Expand Down Expand Up @@ -454,7 +454,7 @@ document {
LI { TO "StronglyStableIdeals::StronglyStableIdeals", ", a package by Davide Alberelli and Paolo Lella for studying strongly stable ideals related to Hilbert polynomials, has been added." },
LI { TO "SLnEquivariantMatrices::SLnEquivariantMatrices", ", a package by Ada Boralevi, Daniele Faenzi and Paolo Lella for computations related to the paper \"A construction of equivariant bundles on the space of symmetric forms\", has been added." },
LI { TO "CorrespondenceScrolls::CorrespondenceScrolls", ", a package by David Eisenbud, Frank-Olaf Schreyer, and Alessio Sammartano, to compute and analyze examples of correspondence scrolls, has been added." },
LI { TO "NCAlgebra::NCAlgebra", ", a package by Frank Moore, Andrew Conner, and Courtney Gibbons, implementating data types for noncommutative algebras, has been added." },
LI { TO "NCAlgebra::NCAlgebra", ", a package by Frank Moore, Andrew Conner, and Courtney Gibbons, implementing data types for noncommutative algebras, has been added." },
LI { TO "SpaceCurves::SpaceCurves", ", a package by Frank Schreyer, Mike Stillman, and Mengyuan Zhang, for generation of space curves, has been added." },
LI { TO "ExteriorIdeals::ExteriorIdeals", ", a package by Marilena Crupi and Luca Amata for manipulating monomial ideals over exterior algebras, has been added." }
}
Expand Down Expand Up @@ -1696,7 +1696,7 @@ document {
"The function ", TO "Elimination::eliminate", , " has been fixed. The function previously quietly assumed a flat polynomial ring,
with no quotient elements, and also quietly assumed that the ring was commutative. Now error
messages are given when it would have produced incorrect answers, and it handles Weyl and skew
commutative poly rings correctly. Addtionally, this function now uses an elimination order
commutative poly rings correctly. Additionally, this function now uses an elimination order
rather than a product order, improving performance in many cases."
},
LI {
Expand Down Expand Up @@ -2260,13 +2260,13 @@ document {
///,
PARA ///
The speed of computation of projective resolutions when the first
components of the degrees of the variables are not necesarily positive has
components of the degrees of the variables are not necessarily positive has
been improved.
///,
PARA ///
The interpreter has been fixed so it more often detects extreme recursion;
one case was omitted that allowed the machine stack to overflow with a
segmenation fault.
segmentation fault.
///,
PARA ///
The function "betti" now returns a new type of object of class BettiTally,
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Macaulay2Doc/debugging.m2
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ document {
GenerateAssertions => Boolean => {
"whether to print assertion statements that can be used as input to Macaulay2 to
check the behavior of the function remains the same. Arguments and values are prepared
with ", TO "toExternalString", ", failure of which is sliently ignored."
with ", TO "toExternalString", ", failure of which is silently ignored."
}
},
Outputs => { Function => {"a new function that returns the same values that ", TT "f", " would have returned, but has a few side effects
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Macaulay2Doc/doc11.m2
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ document {
Outputs => {{ "a list equivalent to ", TT "x", ", in which runs and sequences have been expressed
symbolically as ", TO2{Expression,"expressions"}}},
PARA {"The result is useful in printed displays, as a way of making them more compact. The original list can
be recovered by appying ", TO "value", " to the elements of the result, and then using ", TO "deepSplice", ",
be recovered by applying ", TO "value", " to the elements of the result, and then using ", TO "deepSplice", ",
provided that ", TT "x", " contains no entries that are sequences."},
EXAMPLE lines ///
x = {1,2,3,a,b,c,a,b,c,4,4,4,"asdf"};
Expand Down
4 changes: 2 additions & 2 deletions M2/Macaulay2/packages/Macaulay2Doc/doc12.m2
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ document {
document {
Key => IndeterminateNumber,
Headline => "the class of all indeterminate numbers",
"Indeterminate numbers result, for exmaple, from multiplying 0 by infinity.
"Indeterminate numbers result, for example, from multiplying 0 by infinity.
There is only one instance of this class."
}

Expand Down Expand Up @@ -252,7 +252,7 @@ document {
Key => Holder,
Headline => "the class of all holder expressions",
PARA{},
"This type of expresssion is a container for a single, arbitrary, thing that
"This type of expression is a container for a single, arbitrary, thing that
is basic enough that the correct method for printing does not depend
on its neighbors in the containing expression. A negative number would
not be basic enough for this purpose, since as a member of a sum, it would
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Macaulay2Doc/doc2.m2
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ document {
"This function can be used for multiplying polynomials, where it
can be used in code something like this:",
PRE " combine(x, y, monomialTimes, coeffTimes, coeffPlus)",
"We illustrate that with a simple-minded implmentation of the free ring on the English alphabet, representing words
"We illustrate that with a simple-minded implementation of the free ring on the English alphabet, representing words
as string and polynomials as hash tables that associate coefficients to words.",
EXAMPLE lines ///
Poly = new Type of HashTable
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Macaulay2Doc/doc_strings.m2
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ document {
TT "unstack x", " -- produces a list of strings, each containing the
characters in one row of the ", TT "Net", " ", TT "x", ".",
PARA{},
"The orginal net, adjusted so its height is 1, may be recovered
"The original net, adjusted so its height is 1, may be recovered
with ", TO "stack", ". The individual strings will have
all trailing spaces removed, unless this would make all of them
narrower than the original net, in which case the first string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ doc ///
with the ring, and its opposite ring, i.e. this switches left and right modules of the ring.

This is implemented in the following simple manner: each monomial which has exactly $d$
skew commuting variables occuring (thus, with exponent 1 each), is multiplied by
skew commuting variables occurring (thus, with exponent 1 each), is multiplied by
$(-1)^{(d-1)(d-2)/2}$.
Example
R = ZZ/32003[a..f, SkewCommutative => true]
Expand Down
4 changes: 2 additions & 2 deletions M2/Macaulay2/packages/Macaulay2Doc/functions/degree-doc.m2
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ document {
as often as possible, then evaluates it at ", TT "T=1", ".
When the module has finite length,
the result is the Hilbert series evaluated
at 1, that is the dimension over the ground field, which for a graded (homogenous)
at 1, that is the dimension over the ground field, which for a graded (homogeneous)
is the same as the length."
},
Caveat => {
Expand Down Expand Up @@ -228,7 +228,7 @@ document {
List => {"the degree or multidegree of ", TT "f"}
},
"In Macaulay2, the degree of a polynomial is a list of integers.
This is to accomodate polynomial rings having multigradings. The
This is to accommodate polynomial rings having multigradings. The
usual situation is when the ring has the usual grading: each variable has
length 1.",
EXAMPLE {
Expand Down
6 changes: 3 additions & 3 deletions M2/Macaulay2/packages/Macaulay2Doc/functions/document-doc.m2
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Node
Outputs => { outputs, ... },
SourceCode => { METHOD1, ... }, -- usually not needed
Consequences => { side-effects, ... },
"A list of strings containings names of files in the auxiliary
"A list of strings containing names of files in the auxiliary
directory of the package can go here; the files will be visible
in the current directory while example code is run.",
ExampleFiles => {"datafile1", "datafile2"},
Expand Down Expand Up @@ -308,7 +308,7 @@ Node
Code
EXAMPLE { PRE ////Consequences => {
{ "the headline string will be used to annotate itemized
lists of crossreferences to the documentation ", TO "Key" }}//// }
lists of cross-references to the documentation ", TO "Key" }}//// }

Node
Key
Expand Down Expand Up @@ -393,7 +393,7 @@ Node
document { ... , Subnodes => { ... }, ... }
Consequences
Item
the documentation subnodes listed will appear as decendents of this node in the documentation tree
the documentation subnodes listed will appear as descendents of this node in the documentation tree
Description
Text
This option inserts into a documentation page a menu of subnodes and defines how the tree structure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Node
If @TT "UserMode => false"@ given, the dictionaries available to the user will not be
affected by the evaluation and @TO collectGarbage@ is called afterwards.

Errors occured while evaluating @TT "str"@ do not cause an error outside of @TT "capture"@.
Errors occurred while evaluating @TT "str"@ do not cause an error outside of @TT "capture"@.
Example
(err, output) = capture //// stderr << "Checking a false statement:" << endl; 1/0 ////
assert err
Expand Down
4 changes: 2 additions & 2 deletions M2/Macaulay2/packages/Macaulay2Doc/functions/gb-doc.m2
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ document {
is computed, so that reduction modulo the Gröbner basis can be used to determine membership in ", TT "M", ". When relations are present, the
option ", TO "SyzygyRows", " is set to the number of columns of ", TT "generators I", ", so that if ", TT "ChangeMatrix => true", " is used, then
division by the Gröbner basis can be to express
an element of ", TT "F", " as a linear combination of columns of ", TT "generators I", ", avoiding the computation of the coefficents of the columns
an element of ", TT "F", " as a linear combination of columns of ", TT "generators I", ", avoiding the computation of the coefficients of the columns
of ", TT "relations I", ", leaving all the information that is required to specify an element of ", TT "I", "."
},
EXAMPLE lines ///
Expand Down Expand Up @@ -209,7 +209,7 @@ document {
PARA{},
"Indicates that during computation of a Gröbner basis, the reduction
routine will be replaced by one that will handle long polynomials more
efficiently using \"geobuckets\", which accomodate the terms in buckets
efficiently using \"geobuckets\", which accommodate the terms in buckets
of geometrically increasing length. This method was first used
successfully by Thomas Yan, graduate student in CS at Cornell.",
SeeAlso => {[gb,Strategy]}
Expand Down
16 changes: 8 additions & 8 deletions M2/Macaulay2/packages/Macaulay2Doc/functions/genera-doc.m2
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ document {
arithmetic genera of projective scheme ", TT "V"," with homogeneous coordinate
ring ", TT "R"}
},
"Computes the list of succesive linear sectional arithmetic genera,
"Computes the list of successive linear sectional arithmetic genera,
where the i-th entry in the list is the arithmetic genus of the i-th
succesive generic hyperplane section of ", TT "V", " ",
successive generic hyperplane section of ", TT "V", " ",
"(= (-1)^dim-lin-section * (chi(OO_lin-section) - 1)).",
EXAMPLE {
"R = ZZ/101[x_0..x_4];",
Expand All @@ -33,10 +33,10 @@ document {
Inputs => {"M"
},
Outputs => {List =>{"of the successive linear sectional
arithmetic genera of the succesive generic hyperplane restrictions
arithmetic genera of the successive generic hyperplane restrictions
of ", TT "M"}
},
"Computes the list of succesive generic linear sectional arithmetic genera,
"Computes the list of successive generic linear sectional arithmetic genera,
where the i-th entry in the list is
(-1)^dim-support -i * (chi(M ** OO_lin-section) - 1)).",
EXAMPLE {
Expand All @@ -54,9 +54,9 @@ document {
Outputs => {List =>{"of the successive linear sectional
arithmetic genera of ", TT "I"}
},
"Computes the list of succesive linear sectional arithmetic genera,
"Computes the list of successive linear sectional arithmetic genera,
where the i-th entry in the list is the arithmetic genus of the i-th
succesive generic hyperplane section of the zero-locus of ", TT "I", " ",
successive generic hyperplane section of the zero-locus of ", TT "I", " ",
"(= (-1)^dim-lin-section * (chi(OO_lin-section) - 1)).",
PARA{},
"A complete intersection of type (2,3) in projective fourspace;
Expand All @@ -77,9 +77,9 @@ document {
Outputs => {List => {"of the successive linear sectional
arithmetic genera of ", TT "V"}
},
"Computes the list of succesive linear sectional arithmetic genera,
"Computes the list of successive linear sectional arithmetic genera,
where the i-th entry in the list is the arithmetic genus of the i-th
succesive generic hyperplane section of ", TT "V", " ",
successive generic hyperplane section of ", TT "V", " ",
"(= (-1)^dim-lin-section * (chi(OO_lin-section) - 1)).",
PARA{},
"A complete intersection of type (2,3) in projective fourspace;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ doc ///
horizontalJoin(A,B)
Text
Nested sequences in the input are automatically spliced. For instance, in
the next example the input is intepreted as {\tt \{A, B, A, B, A\}}.
the next example the input is interpreted as {\tt \{A, B, A, B, A\}}.
Example
horizontalJoin {(A, B), (A, B, (A))}
Text
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Node
Headline
compute the inverse

-- TOOD: ModuleMap as well?
-- TODO: ModuleMap as well?
Node
Key
(inverse, Matrix)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

document {
Key => {isPolynomialRing, (isPolynomialRing,Thing), (isPolynomialRing,PolynomialRing)},
Headline => "whether someting is a polynomial ring",
Headline => "whether something is a polynomial ring",
Usage => "isPolynomialRing R",
Inputs => {
"R" => Thing
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Macaulay2Doc/functions/match-doc.m2
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ doc ///
match({"Cat", "Dog"}, "CatDog")
match({"Cat", "Dog"}, "Catfish")
Text
Optinally, @TT "Strategy => all"@ indicates that the string should match every pattern in the list
Optionally, @TT "Strategy => all"@ indicates that the string should match every pattern in the list
to be a match.
Example
match({"Cat", "Dog"}, "CatDog", Strategy => all)
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Macaulay2Doc/functions/method-doc.m2
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ document {
///,
Subnodes => {
TO "specifying typical values",
":Types of method funcions",
":Types of method functions",
TO MethodFunction,
TO MethodFunctionSingle,
TO MethodFunctionBinary,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
--- status: Draft
--- author(s): Amelia Taylor
--- notes: This is a new file bringing together both prune and minPres as a
--- complete minimal presetation collection. trim is inherently
--- complete minimal presentation collection. trim is inherently
--- different as it minimizes to the extent possible while preserving
--- the ambient module.

Expand Down
4 changes: 2 additions & 2 deletions M2/Macaulay2/packages/Macaulay2Doc/functions/nextPrime-doc.m2
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,12 @@ doc ///
of a K-rational point on V(I)
Description
Text
If X has codimension 1, then we intersect X with a randomly choosen
If X has codimension 1, then we intersect X with a randomly chosen
line, and hope that the decomposition of the the intersection contains a
K-rational point. If n=degree X then the probability P that this happens, is the
proportion of permutations in $S_n$ with a fix point on $\{1,\ldots,n \}$,
i.e. $$P=\sum_{j=1}^n (-1)^{j-1} binomial(n,j)(n-j)!/n! = 1-1/2+1/3! + \ldots $$
which approachs $1-exp(-1) = 0.63\ldots$. Thus a probabilistic approach works.
which approaches $1-exp(-1) = 0.63\ldots$. Thus a probabilistic approach works.

For higher codimension we first project X birationally onto a
hypersurface Y, and find a point on Y. Then we take the preimage of this point.
Expand Down
4 changes: 2 additions & 2 deletions M2/Macaulay2/packages/Macaulay2Doc/functions/package-doc.m2
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ Node
loadPackage FirstPackage
Text
In fact this version of the command is simply a convenient shortcut for @TT "loadPackage"@ with the option
@TT "Reload"@ overriden to true.
@TT "Reload"@ overridden to true.
SeeAlso
"packages"
readPackage
Expand Down Expand Up @@ -229,7 +229,7 @@ Node
Consequences
Item
loads the package @TT "PackageName"@ by loading the file @TT "PackageName.m2"@ which should appear
in one of the directories occuring in the list @TO "path"@, unless it has already been loaded, in
in one of the directories occurring in the list @TO "path"@, unless it has already been loaded, in
which case it ensures that the package's dictionary of exported symbols occurs in @TO "dictionaryPath"@
and are thus available to the user. In addition, the function @TO needsPackage@ is applied to each
of the packages whose names are specified by the @TO [newPackage, PackageExports]@ option for the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ document {
partition(odd, tally L)
partition (even, {3,3,5},{true,false})
///,
"The following example parititions the generators of an ideal by degree.",
"The following example partitions the generators of an ideal by degree.",
EXAMPLE lines ///
R = QQ[a..f]
I = ideal"ab,ade,ac3,d4,b3,adf,f4,e10"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ document {
-- PARA{},
-- "The computation is stashed inside the ring map, until the computation has
-- finished completely. This means that you may interrupt this command, and
-- later restart it. You may alo obtain partial results, as follows.",
-- later restart it. You may also obtain partial results, as follows.",
-- EXAMPLE lines ///
-- F = map(S,R,matrix{{s^4, s^3*t, s*t^3, t^4}})
-- pushForward1(F,S^1,DegreeLimit=>8)
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Macaulay2Doc/functions/random-doc.m2
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ document { Key => {(randomMutableMatrix, ZZ, ZZ, RR, ZZ),
entries is less than ", TT "max", ", and
the frequency of entries equal to zero is given by ", TT "zerof", "." }
},
"This function has been superceded by ", TO fillMatrix, ", which works over
"This function has been superseded by ", TO fillMatrix, ", which works over
more rings, is much faster for large matrices, and is more flexible.",
EXAMPLE lines ///
randomMutableMatrix(10,15,.9,100)
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Macaulay2Doc/functions/regex-doc.m2
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ doc ///
@TT "[A-C]"@ -- match any character from @TT "A"@ through @TT "C"@
@TT "[^...]"@ -- match non-listed characters, ranges, or classes
:Character classes
@TT "[:alnum:]"@ -- any alpha-numeric character
@TT "[:alnum:]"@ -- any alphanumeric character
@TT "[:alpha:]"@ -- any alphabetic character
@TT "[:blank:]"@ -- any whitespace or tab character
@TT "[:cntrl:]"@ -- any control character
Expand Down
Loading

0 comments on commit a510fda

Please sign in to comment.