Tests: make sure all functions/classes have 'Example:' lines

McStasMcXtrace / iFit

a simple library to analyze data (with McCode and Phonons/DFT hooks). :warning: this project has been moved to https://gitlab.com/soleil-data-treatment/soleil-software-projects/remote-desktop

http://ifit.mccode.org

Other

5 stars 5 forks source link

Tests: make sure all functions/classes have 'Example:' lines #188

Closed farhi closed 5 years ago

farhi commented 5 years ago

Each class/function should have lines which start with 'Example:'.

The auto test procedure is then

collect class methods: m=methods('class')
collect functions recursively (not being classes)
get the help for each class method: h=help(['class.' m{index} ])
get the help for each function: h=help(m{index})
grab Example: lines
test that Example code executes
test for a return value (must be true)

This allows to set simple Unit tests without writting more complex functions as today.

farhi commented 5 years ago

DONE. The runtest #194 and https://github.com/McStasMcXtrace/iFit/commit/71b4645e8257110cbc19b2b0d23ff94298436d00 estruct (iData) method shows methods without 'Example:' line. It also searches for 'testestruct' function.