File: tests-doc.m2

package info (click to toggle)
macaulay2 1.25.05%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 172,152 kB
  • sloc: cpp: 107,824; ansic: 16,193; javascript: 4,189; makefile: 3,899; lisp: 702; yacc: 604; sh: 476; xml: 177; perl: 114; lex: 65; python: 33
file content (50 lines) | stat: -rw-r--r-- 1,367 bytes parent folder | download | duplicates (3)
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
44
45
46
47
48
49
50
doc ///
  Key
    tests
    (tests, Package)
    (tests, String)
    (tests, ZZ, Package)
    (tests, ZZ, String)
    TestInput
    (code, TestInput)
    (locate, TestInput)
  Headline
    locate a package's tests
  Usage
    tests pkg
    tests(i, pkg)
  Inputs
    i:ZZ
    pkg:{Package, String}
  Outputs
    :{NumberedVerticalList, TestInput}
  Description
    Text
      When an integer is not provided, this returns all the tests
      for the given package.  The position of each element 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"
    Text
      If the test number is also provided, then the corresponding
      @TT "TestInput"@ object is returned.
    Example
      t = tests(0, "FirstPackage")
    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.
///