<< bench_run Development tools test_run >>

Scilab Help >> Development tools > example_run

example_run

Launch the examples found in help pages.

Syntax

example_run()
example_run(moduleNames)
example_run(moduleNames, functionNames)
example_run(moduleNames, functionNames, language)
example_run(moduleNames, functionNames, language, testrunOptions, testrunExportToFile)

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("elementary_functions", "insertion")
    example_run("elementary_functions", ["insertion"; "extraction"])
    example_run("elementary_functions", "insertion", "en_US")
end

See also

History

VersionDescription
5.4.0 Function example_run introduced.

Report an issue
<< bench_run Development tools test_run >>