Ticket #6664 (closed: fixed)

Opened 8 years ago

Last modified 5 years ago

Error if no documentation page

Reported by: Owen Arnold Owned by: Owen Arnold
Priority: major Milestone: Release 2.5
Component: Mantid Keywords:
Cc: Blocked By: #6660
Blocking: #6666 Tester: Dereck Kachere

Description

If there is not algorithm page. We want the wikimaker to stop and output this. Also, if running in --report mode, we want the failure elements in the xml to include this information.

Attachments

Dummy.py​ (329 bytes) - added by Owen Arnold 8 years ago.

Change History

comment:1 Changed 8 years ago by Owen Arnold

You will need to verify #6660 first.

comment:2 Changed 8 years ago by Owen Arnold

  • Blocked By 6660 added

comment:3 Changed 8 years ago by Owen Arnold

  • Status changed from new to accepted

Changed 8 years ago by Owen Arnold

comment:4 Changed 8 years ago by Owen Arnold

refs #6664 no wiki page is a failure.

Changeset: 8d92798f8079e715db9fe90cd79cadf9df4f1656

comment:5 Changed 8 years ago by Owen Arnold

  • Status changed from accepted to verify
  • Resolution set to fixed

Tester: The wikimaker should now output errors and exit the current processing of the algorithm if the wiki page does not exist.

Try this.

  • Register the attached algorithm 'Dummy.py' (I just put it into my PythonAlgorithms directory). This does NOT have a wikipage.
  • Now run the wikimaker with the --dry-run and --report options providing Dummy as the algorithm argument to create the wiki for.
  • The wiki maker should print out that the wiki page does not exist. This information should also be in the generated WikiMakerReport.xml

For sanity, check that the wikimaker still works with algorithms that do have a wiki page.

comment:6 Changed 8 years ago by Owen Arnold

  • Blocking 6666 added

comment:7 Changed 8 years ago by Owen Arnold

Tester please test #6660 first.

comment:8 Changed 8 years ago by Owen Arnold

refs #6664 no wiki page is a failure.

Changeset: 8d92798f8079e715db9fe90cd79cadf9df4f1656

comment:9 Changed 8 years ago by Dereck Kachere

  • Status changed from verify to verifying
  • Tester set to Dereck Kachere

comment:10 Changed 8 years ago by Dereck Kachere

  • Status changed from verifying to closed

Followed the testing instructions. If a wiki page does not exist for an algorithm, Dummy in this case, and wikimaker is run, there is indeed an error message informing the user that the algorithm is not registered.

Testing on an algorithm with a wiki page, ConjoinSpectra in this instance, the user is informed that the "generated wiki page is identical to that on the website."

comment:11 Changed 8 years ago by Owen Arnold

refs #6664 no wiki page is a failure.

Changeset: 8d92798f8079e715db9fe90cd79cadf9df4f1656

comment:12 Changed 8 years ago by Owen Arnold

refs #6664 no wiki page is a failure.

Changeset: 8d92798f8079e715db9fe90cd79cadf9df4f1656

comment:13 Changed 8 years ago by Owen Arnold

refs #6664 no wiki page is a failure.

Changeset: 00a893488453174598d5ba2861046a51fa01ffaa

comment:14 Changed 8 years ago by Owen Arnold

refs #6664 no wiki page is a failure.

Changeset: 8d92798f8079e715db9fe90cd79cadf9df4f1656

comment:15 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​7510

Note: See TracTickets for help on using tickets.