Ticket #9921 (assigned)

Opened 6 years ago

Last modified 5 years ago

Add missing Algorithm Usage examples

Reported by: Nick Draper Owned by: Vickie Lynch
Priority: major Milestone: Backlog
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: #7517 Tester:

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. PredictPeaks
  2. NormaliseVanadium
  3. SortHKL
  4. LoadIsawSpectrum
  5. SaveZODS
  6. SelectCellWithForm
  7. IntegratePeakTimeSlices
  8. LoadTOFRawNexus
  9. SortByQVectors
  10. DiffractionEventCalibrateDetectors
  11. ShowPossibleCells
  12. LoadIsawDetCal
  13. LoadDaveGrp

Please add a usage example wherever possible

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Owner changed from Nick Draper to Vickie Lynch
  • Status changed from new to assigned
  • Description modified (diff)
  • Summary changed from Add missing Algorithm Usage examples (cloned) to Add missing Algorithm Usage examples

comment:2 Changed 6 years ago by Vickie Lynch

This is primarily a duplicate of 9714 which is being verified. There are 3 algorithms which do not have doc tests in develop excluding SortByQVectors which has a ticket 10026 to get it working again.

PredictPeaks LoadTOFRawNexus LoadDaveGrp

comment:3 Changed 6 years ago by Nick Draper

  • Blocking 7517 added

comment:4 Changed 6 years ago by Vickie Lynch

  • Milestone changed from Release 3.3 to Backlog

comment:5 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10763

Note: See TracTickets for help on using tickets.