Ticket #9908 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Add missing Algorithm Usage examples

Reported by: Nick Draper Owned by: Nick Draper
Priority: major Milestone: Release 3.3
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: #7517 Tester: Michael Reuter

Description (last modified by Nick Draper) (diff)

The following algorithms were found to be missing usage examples or have no rst file at all.

The outstanding documentation tickets were checked, but a match could not be found, so these appear to be missed.

  1. RunPythonScript -Done
  2. LoadEventNexus -Done
  3. ConjoinWorkspaces -Done already
  4. LoadIsawPeaks -Done
  5. ConjoinFiles -Done
  6. AddTimeSeriesLog - Done
  7. LoadNexusProcessed - Done
  8. LoadAscii - Done
  9. CropWorkspace - Done already
  10. FakeISISEventDAE - done in 9671
  11. LoadEmptyInstrument - done
  12. DeleteLog - done
  13. CrossCorrelate - done already
  14. RenameWorkspace - Done
  15. Squares - Done
  16. SelectCellOfType - done already

Please add a usage example wherever possible

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Status changed from new to assigned

comment:2 Changed 6 years ago by Nick Draper

  • Status changed from assigned to inprogress

re #9908 RunPythonScript and LoadEventNexus

Changeset: 856b2b516f6212d391a0c643cc0d98c61e879e98

comment:3 Changed 6 years ago by Nick Draper

re #9908 Load IsawPeaks and ConjoinFiles

Changeset: 1b3261b3049b593eb30f82f62cb2f0b10db93e3a

comment:4 Changed 6 years ago by Nick Draper

  • Description modified (diff)

comment:5 Changed 6 years ago by Nick Draper

  • Description modified (diff)

comment:6 Changed 6 years ago by Nick Draper

  • Blocked By 9671 added

comment:7 Changed 6 years ago by Nick Draper

  • Description modified (diff)

comment:8 Changed 6 years ago by Nick Draper

  • Description modified (diff)

comment:9 Changed 6 years ago by Nick Draper

  • Description modified (diff)

comment:10 Changed 6 years ago by Nick Draper

  • Description modified (diff)

comment:11 Changed 6 years ago by Nick Draper

re #9908 done down to and including RenameWorkspace

Changeset: de5cc5fbd87090b37f17e189ad6924200f77a9d4

comment:12 Changed 6 years ago by Nick Draper

re #9908 done squares

Changeset: b19698c64be946ec83118902f67e47e66b4c2ed5

comment:13 Changed 6 years ago by Nick Draper

  • Blocked By 9671 removed

comment:14 Changed 6 years ago by Nick Draper

to test

  1. Check usage tests pass on develop
  2. check some of the usage examples marked above as "done"

comment:15 Changed 6 years ago by Nick Draper

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

comment:16 Changed 6 years ago by Nick Draper

  • Blocking 7517 added

comment:17 Changed 6 years ago by Michael Reuter

  • Status changed from verify to verifying
  • Tester set to Michael Reuter

comment:18 Changed 6 years ago by Michael Reuter

  • Status changed from verifying to reopened
  • Resolution fixed deleted

The usage examples for LoadAscii and LoadNexusProcessed need to print the result of CheckWorkspaceMatch and then have the Success! string in the output section. Otherwise, if CheckWorkspaceMatch fails the usage test won't fail.

comment:19 Changed 6 years ago by Nick Draper

  • Status changed from reopened to inprogress

re #9908 add output sections to LoadAscii and LoadNexusProcessed

Changeset: c405be00da551d15eb3ec5ea160f94af3fe55d7e

comment:20 Changed 6 years ago by Nick Draper

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

comment:21 Changed 6 years ago by Michael Reuter

  • Status changed from verify to verifying

comment:22 Changed 6 years ago by Michael Reuter

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9908_missing_usage_examples_nd'

Full changeset: ​d91c041ae91de983083578f046812c6508bcdf73

comment:23 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10750

Note: See TracTickets for help on using tickets.