example_run

Arguments

moduleNames

a string or a string vector: the name(s) of the modules to test. Default value is the value returned by getmodules().

functionNames

a string or a string vector: the name(s) of the functions to test. If not given, all help pages of the module(s) will be tested.

language

a string: the language of the help pages to test. Default value is "en_US".

testrunOptions

Used as third input argument for test_run.

testrunExportToFile

Used as forth input argument for test_run.

Description

This function extracts the examples given in help pages and run them using test_run.

Example

if ~isempty(ls("SCI/modules/xml/help/en_US/*.xml")) then // Help XML sources must be available for this example
    example_run("xml")
    example_run("core", "insertion")
    example_run("core", ["insertion"; "extraction"])
    example_run("core", "insertion", "en_US")
end

See Also

• test_run — Launches unit tests and non-regression test in a module or directory. The test run checks first that test scripts does not generate an error, then that the test diary (dia files) is the same as the reference diary (dia.ref files).

History