File: tests-doc.m2

package info (click to toggle)
macaulay2 1.21%2Bds-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 133,096 kB
  • sloc: cpp: 110,377; ansic: 16,306; javascript: 4,193; makefile: 3,821; sh: 3,580; lisp: 764; yacc: 590; xml: 177; python: 140; perl: 114; lex: 65; awk: 3
file content (43 lines) | stat: -rw-r--r-- 1,142 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
doc ///
  Key
    tests
    (tests, Package)
    (tests, String)
    TestInput
    (code, TestInput)
    (locate, TestInput)
  Headline
    locate a package's tests
  Usage
    tests pkg
  Inputs
    pkg:Package
      or @ofClass String@
  Outputs
    :HashTable
  Description
    Text
      Returns @ofClass HashTable@ containing the tests for the given
      package.  Each key of this hash table is an integer, which would
      be passed as the first argument of @TO check@ to run the test.
      Each value is a @TT "TestInput"@ object.  These are printed with
      the location of the file so that you may quickly jump to the
      source code of the test when using Emacs.
    Example
      tests "FirstPackage"
      t = oo#0
    Text
      The @TO locate@ and @TO code@ functions do the expected thing
      when given a @TT "TestInput"@ object.
    Example
      locate t
      code t
    Text
      Passing only the key of the desired test to @TO code@ is
      supported as well.
    Example
      code 0
    Text
      You may also pass a @TT "TestInput"@ object to @TO edit@ to open the
      code in your favorite editor.
///