endPackage -- end a new package

Usage:

endPackage pkgname
Inputs:
- pkgname, a string, the name of the package
Outputs:
- a package, the new package
Consequences:
- The package named should have been opened with newPackage. The package is closed, and the former value of dictionaryPath is restored, with the global dictionary (containing the exported symbols) of the package prepended.

Description

A package writer need not call this function explicitly, since the end of file hook for the file containing the newPackage command that opened the package will call endPackage.

i1 : newPackage "Foo"

o1 = Foo

o1 : Package

i2 : export "abc"

o2 = {abc}

o2 : List

i3 : abc = 3

o3 = 3

i4 : dictionaryPath

o4 = {Foo#"private dictionary", Foo.Dictionary, Core.Dictionary,
     ------------------------------------------------------------------------
     OutputDictionary, PackageDictionary}

o4 : List

i5 : endPackage "Foo"

o5 = Foo

o5 : Package

i6 : peek oo

o6 = Package{configuration file name => null                                     }
             Dictionary => Foo.Dictionary
             example data files => MutableHashTable{}
             example inputs => MutableHashTable{}
             example results => MutableHashTable{}
             exported mutable symbols => {}
             exported symbols => {abc}
             loadDepth => 3
             Options => OptionTable{Authors => {}                               }
                                    AuxiliaryFiles => false
                                    CacheExampleOutput => null
                                    Certification => null
                                    Configuration => {}
                                    Date => null
                                    DebuggingMode => false
                                    Headline => null
                                    HomePage => null
                                    InfoDirSection => Macaulay2 and its packages
                                    Keywords => {Uncategorized}
                                    OptionalComponentsPresent => true
                                    PackageExports => {}
                                    PackageImports => {}
                                    Reload => false
                                    UseCachedExampleOutput => false
                                    Version => 0.0
             package prefix => ${prefix}/
             PackageIsLoaded => true
             pkgname => Foo
             private dictionary => Foo#"private dictionary"
             processed documentation => MutableHashTable{}
             raw documentation => MutableHashTable{}
             source directory => /tmp/M2-29157-0/93-rundir/
             source file => stdio
             test inputs => MutableList{}

i7 : dictionaryPath

o7 = {Foo.Dictionary, Varieties.Dictionary, Isomorphism.Dictionary,
     ------------------------------------------------------------------------
     Truncations.Dictionary, Polyhedra.Dictionary, Saturation.Dictionary,
     ------------------------------------------------------------------------
     Elimination.Dictionary, OldChainComplexes.Dictionary,
     ------------------------------------------------------------------------
     TangentCone.Dictionary, SimpleDoc.Dictionary, ReesAlgebra.Dictionary,
     ------------------------------------------------------------------------
     PrimaryDecomposition.Dictionary, MinimalPrimes.Dictionary,
     ------------------------------------------------------------------------
     PackageCitations.Dictionary, OnlineLookup.Dictionary,
     ------------------------------------------------------------------------
     LLLBases.Dictionary, InverseSystems.Dictionary,
     ------------------------------------------------------------------------
     IntegralClosure.Dictionary, ConwayPolynomials.Dictionary,
     ------------------------------------------------------------------------
     Classic.Dictionary, User#"private dictionary", User.Dictionary,
     ------------------------------------------------------------------------
     Core.Dictionary, OutputDictionary, PackageDictionary}

o7 : List

i8 : abc

o8 = 3

This function is called automatically at the end of a file, so package authors don't need to explicitly call endPackage.

Ways to use endPackage:

endPackage(String)

For the programmer

The object endPackage is a method function.

The source of this document is in Macaulay2Doc/functions/package-doc.m2:688:0.