Skip to content

Commit

Permalink
implement some uniformity among package headers
Browse files Browse the repository at this point in the history
- The headline is used as clarification in lists of packages, so is not
  intended as a title, hence in headlines:
  - no capitalization
  - no period at the end
  - the form "a package for ..." is redundant
  - the forms "computations for ..." or "working with ..." are redundant
- no use of "DebuggingMode => true"
- no use of "Reload => true"
  • Loading branch information
DanGrayson committed Nov 25, 2019
1 parent f719c72 commit 7a7e6f9
Show file tree
Hide file tree
Showing 134 changed files with 184 additions and 176 deletions.
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/AdjointIdeal.m2
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ newPackage(
Authors => {{Name => "Janko Boehm",
Email => "boehm@mathematik.uni-kl.de",
HomePage => "http://www.math.uni-sb.de/ag/schreyer/jb/"}},
Headline => "Adjoint ideals of plane curves and related computations",
Headline => "adjoint ideals of plane curves and related computations",
DebuggingMode => false,
CacheExampleOutput => true,
PackageImports => {"IntegralClosure","MapleInterface"},
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/AlgebraicSplines.m2
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ newPackage select((
{Name => "Eliana Duarte", Email => "emduart2@illinois.edu", HomePage => "https://faculty.math.illinois.edu/~emduart2/"},
{Name => "Daniel Irving Bernstein", Email=> "dibernst@ncsu.edu", HomePage =>"http://www4.ncsu.edu/~dibernst"}
},
Headline => "Package for splines on simplicial complexes, polytopal complexes, and graphs",
Headline => "splines on simplicial complexes, polytopal complexes, and graphs",
Configuration => {},
DebuggingMode => false,
PackageImports => { "Elimination" },
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/AnalyzeSheafOnP1.m2
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Authors => {{Name => "David Eisenbud",
Email => "de@msri.org",
HomePage => "http://www.msri.org/~de"}},
Headline => "Decompose a Sheaf on P1",
Headline => "decompose a Sheaf on P1",
DebuggingMode => false
)
export {
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/BIBasis.m2
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ newPackage(
Authors => {
{Name => "Mikhail Zinin", Email => "mzinin@gmail.com"}
},
Headline => "Involutive Pommaret basis in a Boolean ring",
Headline => "involutive Pommaret basis in a Boolean ring",
PackageImports => {"BooleanGB"},
DebuggingMode => false
)
Expand Down
4 changes: 1 addition & 3 deletions M2/Macaulay2/packages/Bertini.m2
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,8 @@ newPackage(
Email => "leykin@math.gatech.edu",
HomePage => "http://www.math.gatech.edu/~leykin"}
},
Headline => "Interface to Bertini",
Headline => "interface to Bertini",
Configuration => { "BERTINIexecutable"=>"bertini" },
-- DebuggingMode => true,
DebuggingMode => true,
AuxiliaryFiles => true,
PackageExports => {"NAGtypes"},
PackageImports => {"NAGtypes"},
Expand Down
8 changes: 3 additions & 5 deletions M2/Macaulay2/packages/BinomialEdgeIdeals.m2
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ newPackage("BinomialEdgeIdeals",
{Name => "Tobias Windisch",
Email => "windisch@ovgu.de",
HomePage => "http://www.uni-magdeburg.de/windisch/"}},
Headline => "Package for computations with binomial edge ideals",
Headline => "binomial edge ideals",
PackageImports => {"Graphs","Binomials"}
)

Expand Down Expand Up @@ -156,11 +156,9 @@ beginDocumentation()

document {
Key => BinomialEdgeIdeals,
Headline => "a package for binomial edge ideals",

Headline => "binomial edge ideals",
EM "BinomialEdgeIdeals", " is a package for computations with binomial edge
ideals",

BR{},BR{},
BOLD "Literature \n",
UL {
Expand All @@ -176,7 +174,7 @@ document {
document {
Key => {parityBinomialEdgeIdeal,
(parityBinomialEdgeIdeal, Graph), (parityBinomialEdgeIdeal, List)},
Headline => "Parity binomial edge ideals",
Headline => "parity binomial edge ideals",
Usage => "parityBinomialEdgeIdeal G",
Inputs => {
"G" => { "a Graph or a List"} },
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Binomials.m2
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ newPackage(
Name => "Thomas Kahle",
Email => "thomas.kahle@jpberlin.de",
HomePage => "http://www.thomas-kahle.de"}},
Headline => "Specialized routines for binomial ideals",
Headline => "specialized routines for binomial ideals",
PackageImports => {"FourTiTwo", "Cyclotomic", "LLLBases", "Elimination"},
Certification => {
"journal name" => "The Journal of Software for Algebra and Geometry: Macaulay2",
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Book3264Examples.m2
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ newPackage(
Email => "charleyc@math.berkeley.edu",
HomePage => "http://math.berkeley.edu/~charleyc/"}},
PackageExports => {"Schubert2", "SchurRings"},
Headline => "Examples to accompany the eponymous book by Eisenbud and Harris"
Headline => "examples to accompany the eponymous book by Eisenbud and Harris"
)

export {"grassmannian", "placeholderSchubertCycle", "diagrams", "placeholderToSchubertBasis"}
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/BooleanGB.m2
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ newPackage(
HomePage => "http://www.math.vt.edu/people/fhinkel/"},
{Name => "Mike Stillman"},
{Name => "Elizabeth Arnold"}},
Headline => "Groebner Bases for Ideals in Boolean Polynomial Quotient Ring",
Headline => "Groebner bases for ideals in Boolean polynomial quotient rings",
DebuggingMode => false
)

Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/ChainComplexExtras.m2
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ newPackage(
{Name => "Greg Smith", Email => "ggsmith@mast.queensu.ca", HomePage => "http://www.mast.queensu.ca/~ggsmith"},
{Name => "Lily Silverstein", Email => "lsilverstein@cpp.edu", HomePage => "https://www.cpp.edu/faculty/lsilverstein/"}
},
Headline => "Some additional ChainComplex Functions.",
Headline => "some additional ChainComplex Functions",
DebuggingMode =>false
)

Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/CharacteristicClasses.m2
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ newPackage(
HomePage => "https://math.berkeley.edu/~mhelmer/"},
{Name => "Christine Jost",
Email => "christine.e.jost@gmail.com"}},
Headline => "Computes CSM classes, Segre classes and the Euler Char. for some Subschemes of Smooth Complete Toric Varieties",
Headline => "CSM classes, Segre classes and the Euler characteristic for some subschemes of smooth complete toric varieties",
DebuggingMode => false,
PackageImports => { "Elimination", "PrimaryDecomposition", "NormalToricVarieties"},
Configuration => { "pathToBertini" => ""},
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Chordal.m2
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ newPackage(
Email => "parrilo@mit.edu",
HomePage => "http://www.mit.edu/~parrilo/"}
},
Headline => "A package that exploits chordal structure",
Headline => "routines that exploit chordal structure",
AuxiliaryFiles => true,
PackageExports => {"Graphs","TriangularSets"}
)
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/CoincidentRootLoci.m2
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ newPackage(
"CoincidentRootLoci",
Version => "0.1.1",
Date => "June 1, 2018",
Headline => "A package for computations with coincident root loci",
Headline => "coincident root loci",
Authors => {{Name => "M. C. Brambilla", Email => "brambilla@dipmat.univpm.it"},
{Name => "G. Staglianò", Email => "giovannistagliano@gmail.com"}},
PackageExports => {"Cremona","Resultants"},
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/CompleteIntersectionResolutions.m2
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ newPackage(
Authors => {{Name => "David Eisenbud",
Email => "de@msri.org",
HomePage => "http://www.msri.org/~de"}},
Headline => "Analyzing Resolutions over a Complete Intersection",
Headline => "analyzing resolutions over a complete intersection",
PackageImports => {"Truncations"},
PackageExports => {"MCMApproximations","BGG"},
--note: this package requires MCMApproximations.m2
Expand Down
5 changes: 2 additions & 3 deletions M2/Macaulay2/packages/Complexes.m2
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,8 @@ newPackage(
{Name => "Gregory G. Smith", Email => "ggsmith@mast.queensu.ca", HomePage => "http://www.mast.queensu.ca/~ggsmith"},
{Name => "Mike Stillman", Email => "mike@math.cornell.edu", HomePage => "http://www.math.cornell.edu/~mike"}
},
Headline => "Chain complexes",
AuxiliaryFiles => false,
DebuggingMode => true
Headline => "chain complexes",
AuxiliaryFiles => false
)

export {
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/ConvexInterface.m2
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ newPackage(
Email =>"boehm@mathematik.uni-kl.de",
HomePage =>"http://www.math.uni-sb.de/ag/schreyer/jb/"}
},
Headline =>"Interface to Convex",
Headline =>"interface to Convex",
DebuggingMode => false,
Configuration =>{"ConvexPath"=>""},
CacheExampleOutput => true,
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/CorrespondenceScrolls.m2
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ newPackage(
{Name =>"Alessio Sammartano",
-- Email => "",
HomePage => ""}},
Headline => "CorrespondenceScrolls",
Headline => "correspondence scrolls",
PackageImports => { "Elimination" }
)

Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Cremona.m2
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ newPackage(
Version => "4.3",
Date => "March 27, 2019",
Authors => {{Name => "Giovanni Staglianò", Email => "giovannistagliano@gmail.com" }},
Headline => "Some computations for rational maps between projective varieties",
Headline => "rational maps between projective varieties",
AuxiliaryFiles => true,
Certification => {
"journal name" => "The Journal of Software for Algebra and Geometry",
Expand Down
6 changes: 3 additions & 3 deletions M2/Macaulay2/packages/Cyclotomic.m2
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ newPackage(
Authors => {{Name => "Thomas Kahle",
Email => "thomas.kahle@jpberlin.de",
HomePage => "http://thomas-kahle.de"}},
Headline => "Routines for cyclotomic fields"
Headline => "cyclotomic fields"
)

export {"cyclotomicField",
Expand Down Expand Up @@ -147,15 +147,15 @@ beginDocumentation()

document {
Key => Cyclotomic,
Headline => "a package for cyclotomic fields",
Headline => "cyclotomic fields",
EM "Cyclotomic", " is a package for cyclotomic fields. It is used in
to construct extensions of the coefficient field during binomial
primary decomposition using the package ", TO "Binomials::Binomials", "."
}

document {
Key => {cyclotomicField},
Headline => "Cyclotomic Field Construction",
Headline => "cyclotomic field construction",
Usage => "cyclotomicField (i)",
Inputs => {
"i" => { "an integer, the power of the root to be adjoined."}},
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/DGAlgebras.m2
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
-- -*- coding: utf-8 -*-
newPackage("DGAlgebras",
Headline => "Data type for DG algebras",
Headline => "data type for DG algebras",
Version => "1.0.1",
Date => "January 11, 2017",
Authors => {
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/DeterminantalRepresentations.m2
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ newPackage("DeterminantalRepresentations",
{Name => "Papri Dey",
Email => "papridey@berkeley.edu"}
},
Headline => "a package for computing determinantal representations",
Headline => "determinantal representations",
HomePage => "https://github.com/papridey/DeterminantalRepresentations",
PackageExports => {"NumericalAlgebraicGeometry"},
DebuggingMode => false,
Expand Down
4 changes: 2 additions & 2 deletions M2/Macaulay2/packages/DiffAlg.m2
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ newPackage (
Email => "fquallb@dm.uba.ar",
HomePage => ""}
},
Headline => "Specialized routines for differential forms",
Headline => "specialized routines for differential forms",
Configuration => {
"BaseRing" => F,
"VariableName" => "x",
Expand Down Expand Up @@ -477,7 +477,7 @@ beginDocumentation()

document {
Key => DiffAlg,
Headline => "a differential algebra package",
Headline => "differential algebra",
PARA {TO DiffAlg, " is a differential algebra package. It can compute the usual operations with polynomial differential forms and vector fields. Its main purpose is to associate algebraic objects to differential operators in the exterior algebra of differential forms."},
PARA {"The simplest way to load the package is with the command:"},
TT {"loadPackage \"DiffAlg\""},
Expand Down
4 changes: 2 additions & 2 deletions M2/Macaulay2/packages/Divisor.m2
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ newPackage( "Divisor",
Authors => {
{Name => "Karl Schwede", Email=> "kschwede@gmail.com", HomePage=> "http://www.math.utah.edu/~schwede"},
{Name=> "Zhaoning Yang", Email=> "zyy5054@gmail.com", HomePage => "http://sites.psu.edu/zhaoningyang"}},
Headline => "a package for working with Weil divisors",
Headline => "Weil divisors",
PackageImports => { "IntegralClosure", "RationalMaps" },
Certification => {
"journal name" => "The Journal of Software for Algebra and Geometry",
Expand Down Expand Up @@ -1944,7 +1944,7 @@ beginDocumentation();

document {
Key => Divisor,
Headline => "a package for computations with divisors",
Headline => "divisors",
EM "Divisor", " is a package for working with (Q/R)-Weil divisors on ", EM "normal", " affine and projective varieties (equivalently, on commutative, normal and graded rings).",
BR{},BR{},
"This package introduces a type ", TO "WeilDivisor", " which lets the user work with Weil divisors similar to the way one might in algebraic geometry. We highlight a few important functions below.",
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Dmodules.m2
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
newPackage("Dmodules",
Version => "1.4.0.1",
Date => "01/28/2011",
Headline => "functions for computations with D-modules",
Headline => "D-modules",
HomePage => "http://people.math.gatech.edu/~aleykin3/Dmodules",
AuxiliaryFiles => true,
Authors => {
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/EdgeIdeals.m2
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ newPackage(
HomePage => "http://flash.lakeheadu.ca/~avantuyl/"
}
},
Headline => "a package for edge ideals.",
Headline => "edge ideals",
DebuggingMode => false
)

Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Elimination.m2
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ newPackage("Elimination",
Version => "1.0",
Date => "January 5, 2005",
Authors => {{Name => "Michael E. Stillman", Email => "mike@math.cornell.edu"}},
Headline => "a package for elimination of variables"
Headline => "elimination of variables"
)

export {"eliminate", "sylvesterMatrix", "discriminant", "resultant"}
Expand Down
4 changes: 2 additions & 2 deletions M2/Macaulay2/packages/EliminationMatrices.m2
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ newPackage("EliminationMatrices",
{Name => "Laurent Busé", Email => "Laurent.Buse@inria.fr", HomePage => "http://www-sop.inria.fr/members/Laurent.Buse/"},
{Name => "Manuel Dubinsky", Email => "manudubinsky@gmail.com" }
},
Headline => "Package for computing resultants",
Headline => "resultants",
PackageImports => { "Elimination" },
DebuggingMode => false
)
Expand Down Expand Up @@ -796,7 +796,7 @@ beginDocumentation()
---------------------------------------------------------------
document {
Key => {EliminationMatrices},
Headline => "A package for computing resultants.",
Headline => "resultants",

TT "EliminationMatrices", " is a package for elimination theory, emphasizing universal formulas, in particular, resultant computations.",

Expand Down
4 changes: 2 additions & 2 deletions M2/Macaulay2/packages/EllipticCurves.m2
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ newPackage(
Email => "oneto@math.su.se"},
{Name => "Stefano Marseglia",
Email => "stefanom@math.su.se"}},
Headline => "Group law on elliptic curves (and counting points with brute force methods)"
Headline => "group law on elliptic curves (and counting points with brute force methods)"
)

export {
Expand Down Expand Up @@ -504,7 +504,7 @@ beginDocumentation()

document {
Key => EllipticCurves,
Headline => "A package for basic functions on elliptic curves and a bruteforce method for point counting.",
Headline => "elliptic curves and a brute-force method for point counting",
}

document {
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/ExampleIdeals.m2
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ newPackage(
Authors => {{Name => "Mike Stillman",
Email => "mike@math.cornell.edu",
HomePage => "http://www.math.cornell.edu/~mike/"}},
Headline => "a package consisting of examples of ideals",
Headline => "examples of ideals",
PackageImports => { "Markov" },
DebuggingMode => false
)
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/ExteriorIdeals.m2
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ newPackage(
Date => "July 13, 2017",
Authors => {{Name => "Marilena Crupi", Email => "mcrupi@unime.it", HomePage => "http://www.unime.it/it/persona/marilena-crupi"},
{Name => "Luca Amata", Email => "lamata@unime.it"}},
Headline => "A Macaulay2 package for manipulating monomial ideals over exterior algebra",
Headline => "monomial ideals over exterior algebras",
DebuggingMode => false,
Certification => {
"journal name" => "The Journal of Software for Algebra and Geometry",
Expand Down
3 changes: 1 addition & 2 deletions M2/Macaulay2/packages/FGLM.m2
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ newPackage(
{ Name => "Dylan Peifer", Email => "djp282@cornell.edu", HomePage => "https://math.cornell.edu/~djp282" },
{ Name => "Mahrud Sayrafi", Email => "mahrud@umn.edu", HomePage => "https://math.umn.edu/~mahrud" }
},
Headline => "Compute Groebner bases via the FGLM algorithm",
DebuggingMode => true
Headline => "Groebner bases via the FGLM algorithm"
)

-*
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/FastLinAlg.m2
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Version => "0.1", Date => "October 21st, 2019", Authors => {
Email=> "yuhuiyao4ever@gmail.com"
}
}, --this file is in the public domain
Headline => "A package for faster linear algebra operations.", DebuggingMode => true, Reload=>true)
Headline => "faster linear algebra operations")
export{
-- "selectSmallestTerms",
"chooseSubmatrixSmallestDegree", --there are checks
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/FiniteFittingIdeals.m2
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
-- UPDATE HISTORY : March 2015 v0.1, May 2015 v1.0
---------------------------------------------------------------------------
newPackage("FiniteFittingIdeals",
Headline => "A package for computing Fitting ideals of finite modules",
Headline => "Fitting ideals of finite modules",
Version => "1.0",
Date => "May 5, 2015",
Authors => {
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/FormalGroupLaws.m2
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ newPackage(
HomePage => "http://www.math.uni-bielefeld.de/~bcalmes/"},
{Name => "Viktor Petrov"}
},
Headline => "Package to deal with commutative formal group laws",
Headline => "commutative formal group laws",
PackageImports => {"Truncations"},
DebuggingMode => false)

Expand Down
Loading

0 comments on commit 7a7e6f9

Please sign in to comment.