Ticket #10994 (new)
Fix somewhat hidden warnings in doc tests
Reported by: | Federico M Pouzols | Owned by: | |
---|---|---|---|
Priority: | major | Milestone: | Release 3.5 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Tester: |
Description
While running runsphinx_doctest I got the following warnings about missing test output:
- WARNING: no code/output in testoutput block at /home/fedemp/mantid-repos/mantid/Code/Mantid/docs/source/algorithms/MDNormSCD-v1.rst:84
- WARNING: no code/output in testcleanup block at /home/fedemp/mantid-repos/mantid/Code/Mantid/docs/source/algorithms/LoadVulcanCalFile-v1.rst:97
- WARNING: no code/output in testoutput block at /home/fedemp/mantid-repos/mantid/Code/Mantid/docs/source/algorithms/SaveFullprofResolution-v1.rst:88
- WARNING: no code/output in testoutput block at /home/fedemp/mantid-repos/mantid/Code/Mantid/docs/source/algorithms/SavePlot1D-v1.rst:54
- WARNING: no code/output in testcleanup block at /home/fedemp/mantid-repos/mantid/Code/Mantid/docs/source/algorithms/RenameLog-v1.rst:35
- WARNING: no code/output in testoutput block at /home/fedemp/mantid-repos/mantid/Code/Mantid/docs/source/algorithms/RenameLog-v1.rst:40
Some of the tests do not print anything, maybe a simple print statement should be added for a basic check of the test outcomes. Other tests, like LoadVulcanCalFile do print something but the expected output is not given in the RST file. This implies that these tests are not checking all the points that they should.
Change History
Note: See
TracTickets for help on using
tickets.
Just a note, Jenkins builds (if successful) will say something like this:
but do not seem to print information about the warnings at the end, so you have to grep/search for uppercase "WARNING" throughout the console output.
For some reason, in my local docs-test builds I get them at the end too.