Ticket #9917 (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: Harry Jeffery

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. LoadCanSAS1D
  2. LoadRKH

Please add a usage example wherever possible

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Owner changed from Nick Draper to Peter Parker
  • 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 Nick Draper

  • Blocking 7517 added

comment:3 Changed 6 years ago by Nick Draper

  • Owner changed from Peter Parker to Nick Draper

comment:4 Changed 6 years ago by Nick Draper

  • Status changed from assigned to inprogress

re #9917 Added usage examples

Changeset: a34a31b9cc3033378ff3c73462a7d8d01b5b4a3c

comment:5 Changed 6 years ago by Nick Draper

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

To test

The following pages should have usage examples and the doctest build should have passed on the build server.

  1. LoadCanSAS1D
  2. LoadRKH

comment:6 Changed 6 years ago by Harry Jeffery

  • Status changed from verify to verifying
  • Tester set to Harry Jeffery

comment:7 Changed 6 years ago by Harry Jeffery

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9917_Peter_Parkers_missing_usage_examples'

Full changeset: ​16095046e4f7b035ce3b11bf90b90577bc5900fe

comment:8 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10759

Note: See TracTickets for help on using tickets.