Add docs for GAP.Packages.test

oscar-system · Nov 22, 2024 · 5e51614 · 5e51614
1 parent 57dadc1
commit 5e51614
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/.github/workflows/CI-distro.yml b/.github/workflows/CI-distro.yml
@@ -72,4 +72,4 @@ jobs:
       - name: "Build GAP package"
         run: julia --color=yes --project=. -e 'using GAP; GAP.Packages.build("${{ matrix.gap-package }}")'
       - name: "Run GAP package tests"
-        run: julia --color=yes --project=. -e 'using GAP; GAP.Packages.test("${{ matrix.gap-package }}")'
+        run: julia --color=yes --project=. -e 'using GAP, Test; GAP.Packages.test("${{ matrix.gap-package }}")'
diff --git a/docs/src/packages.md b/docs/src/packages.md
@@ -14,6 +14,7 @@ GAP.Packages.install
 GAP.Packages.update
 GAP.Packages.remove
 GAP.Packages.build
+GAP.Packages.test
 GAP.Packages.locate_package
 ```
 
diff --git a/src/packages.jl b/src/packages.jl
@@ -409,6 +409,17 @@ function build(name::String; quiet::Bool = false,
   return res
 end
 
+"""
+    test(name::String)
+
+Test the GAP package with name `name`.
+
+The function uses [the function `TestPackage`](GAP_ref(ref:TestPackage)).
+
+Use-sites of this function should verify that the `Test` package is loaded
+before calling this function, as this function might be moved
+to a package extension that depends on the `Test` package in the future.
+"""
 function test(name::String)
   global disable_error_handler