endPackage(String) -- end a new package

Synopsis

Usage:
endPackage pkgname
Function: endPackage
Inputs:
- pkgname, a string, the name of the 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.
Outputs:
- a package, the new package

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 = {SimpleDoc.Dictionary, Elimination.Dictionary, LLLBases.Dictionary,
     ------------------------------------------------------------------------
     IntegralClosure.Dictionary, PrimaryDecomposition.Dictionary,
     ------------------------------------------------------------------------
     Classic.Dictionary, SchurRings.Dictionary, TangentCone.Dictionary,
     ------------------------------------------------------------------------
     ReesAlgebra.Dictionary, ConwayPolynomials.Dictionary, Foo#"private
     ------------------------------------------------------------------------
     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 inputs => MutableHashTable{}
             example results => MutableHashTable{}
             exported mutable symbols => {}
             exported symbols => {abc}
             index.html => /builddir/build/BUILD/Macaulay2-1.3.1-r10737/StagingArea/common/share/doc/Macaulay2/Foo/html/index.html
             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
                                    Version => 0.0
             package prefix => /builddir/build/BUILD/Macaulay2-1.3.1-r10737/StagingArea/
             private dictionary => Foo#"private dictionary"
             processed documentation => MutableHashTable{}
             raw documentation => MutableHashTable{}
             source directory => /tmp/M2-30357-120-rundir/
             source file => stdio
             test inputs => MutableHashTable{}
             test number => 0
             title => Foo
             undocumented keys => MutableHashTable{}

i7 : dictionaryPath

o7 = {Foo.Dictionary, SimpleDoc.Dictionary, Elimination.Dictionary,
     ------------------------------------------------------------------------
     LLLBases.Dictionary, IntegralClosure.Dictionary,
     ------------------------------------------------------------------------
     PrimaryDecomposition.Dictionary, Classic.Dictionary,
     ------------------------------------------------------------------------
     SchurRings.Dictionary, TangentCone.Dictionary, ReesAlgebra.Dictionary,
     ------------------------------------------------------------------------
     ConwayPolynomials.Dictionary, User#"private dictionary",
     ------------------------------------------------------------------------
     Core.Dictionary, OutputDictionary, PackageDictionary}

o7 : List

i8 : abc

o8 = 3