Document the TestFiles option to newPackage

Macaulay2 · Sep 29, 2024 · 93c1355 · 93c1355
1 parent c8efd14
commit 93c1355
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/M2/Macaulay2/packages/Macaulay2Doc/functions/check-doc.m2 b/M2/Macaulay2/packages/Macaulay2Doc/functions/check-doc.m2
@@ -90,8 +90,9 @@ Node
       One provides tests using the @TO symbol TEST@ function following the @TO beginDocumentation@ call in the source
       of the package.
 
-      Optionally, one can store all tests in a @TT "tests.m2"@ directory under the auxiliary subdirectory of
-      the package and load the file from the main package source file.
+      Optionally, one can store tests as files in the auxiliary subdirectory of
+      the package and include their filenames in the @TO TestFiles@ option
+      to @TO newPackage@.
 
       For example, to run the tests for the @TO "LLLBases :: LLLBases"@ package (Lenstra-Lenstra-Lovasz bases), use:
     CannedExample

diff --git a/M2/Macaulay2/packages/Macaulay2Doc/functions/package-doc.m2 b/M2/Macaulay2/packages/Macaulay2Doc/functions/package-doc.m2
@@ -271,6 +271,7 @@ Node
     [newPackage, PackageExports]
     [newPackage, PackageImports]
     [newPackage, Reload]
+    [newPackage, TestFiles]
     [newPackage, UseCachedExampleOutput]
     [newPackage, Version]
     Name
@@ -338,6 +339,9 @@ Node
       but a backup will be made and the user's settings for the surviving options will be retained.
     Reload=>Boolean
       whether to reload the package, if it has been loaded before
+    TestFiles=>List
+      of strings, names of auxiliary files to be run as part of the package's
+      test suite when calling @TO check@
   Outputs
     :Package
       the new package