Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix somewhat hidden warnings in doc tests #11833

Closed
mantid-builder opened this issue Jan 29, 2015 · 3 comments
Closed

Fix somewhat hidden warnings in doc tests #11833

mantid-builder opened this issue Jan 29, 2015 · 3 comments
Labels
Documentation Issues and pull requests related to documentation Maintenance Unassigned issues to be addressed in the next maintenance period. Stale This label is automatically applied to issues that are automatically closed by the stale bot

Comments

@mantid-builder
Copy link
Collaborator

This issue was originally TRAC 10994

Original Reporter: @FedeMPouzols

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.

@mantid-builder
Copy link
Collaborator Author

@FedeMPouzols (2015-01-29T16:52:22):
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.


@NickDraper (2015-04-27T08:10:35):
Moved to R3.5 at the R3.4 code freeze

@mantid-builder mantid-builder added the Documentation Issues and pull requests related to documentation label Jun 3, 2015
@mantid-builder mantid-builder added this to the Release 3.5 milestone Jun 3, 2015
DanNixon added a commit that referenced this issue Jun 4, 2015
DanNixon added a commit that referenced this issue Jun 4, 2015
DanNixon added a commit that referenced this issue Jun 4, 2015
DanNixon added a commit that referenced this issue Jun 4, 2015
DanNixon added a commit that referenced this issue Jun 4, 2015
DanNixon added a commit that referenced this issue Jun 4, 2015
DanNixon added a commit that referenced this issue Jun 4, 2015
DanNixon added a commit that referenced this issue Jun 4, 2015
@NickDraper NickDraper modified the milestones: Release 3.5, Release 3.6 Sep 14, 2015
@NickDraper NickDraper modified the milestone: Release 3.6 Jan 22, 2016
@NickDraper NickDraper added the Maintenance Unassigned issues to be addressed in the next maintenance period. label Feb 19, 2016
@stale
Copy link

stale bot commented Feb 24, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. If you feel this is incorrect please comment to keep it alive, with a reason why.

To prevent closure, e.g. for long-term planning issues, add the "Never Stale" label.

@stale stale bot added the Stale This label is automatically applied to issues that are automatically closed by the stale bot label Feb 24, 2021
@stale
Copy link

stale bot commented Mar 3, 2021

This issue has been closed automatically. If this still affects you please re-open this issue with a comment so we can look into resolving it.

@stale stale bot closed this as completed Mar 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues and pull requests related to documentation Maintenance Unassigned issues to be addressed in the next maintenance period. Stale This label is automatically applied to issues that are automatically closed by the stale bot
Projects
None yet
Development

No branches or pull requests

2 participants