Ticket #10994 (new)

Opened 6 years ago

Last modified 5 years ago

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

comment:1 Changed 6 years ago by Federico M Pouzols

Just a note, Jenkins builds (if successful) will say something like this:

10:04:40 Doctest summary
10:04:40 ===============
10:04:40   580 tests
10:04:40     0 failures in tests
10:04:40     0 failures in setup code
10:04:40     0 failures in cleanup code
10:04:40 build succeeded, 6 warnings.

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.

comment:2 Changed 5 years ago by Nick Draper

  • Milestone changed from Release 3.4 to Release 3.5

Moved to R3.5 at the R3.4 code freeze

comment:3 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 11833

Note: See TracTickets for help on using tickets.