Ticket #9916 (inprogress)

Opened 6 years ago

Last modified 5 years ago

Add missing Algorithm Usage examples

Reported by: Nick Draper Owned by: Owen Arnold
Priority: major Milestone: Backlog
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: #7517, #10181 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. ConvertToReflectometryQ
  2. Stitch1DMD
  3. LoadReflTBL
  4. PolarizationCorrection

Please add a usage example wherever possible

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Owner changed from Nick Draper to Owen Arnold
  • 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 Owen Arnold

  • Status changed from assigned to inprogress

refs #9916. Missing usage for ConvertToReflectometryQ

Changeset: d3cdcab7d03048811a0c58480241054ad6f718bb

comment:4 Changed 6 years ago by Owen Arnold

refs #9916. LoadReflTbl docs and test.

Changeset: 3504c26405e7d087763c64a35da6c78ea3f106ce

comment:5 Changed 6 years ago by Owen Arnold

refs #9916. Missing usage for ConvertToReflectometryQ

Changeset: d3cdcab7d03048811a0c58480241054ad6f718bb

comment:6 Changed 6 years ago by Owen Arnold

refs #9916. LoadReflTbl docs and test.

Changeset: 3504c26405e7d087763c64a35da6c78ea3f106ce

comment:7 Changed 6 years ago by Owen Arnold

refs #9916. Forgot to add file.

Changeset: d53d91125b060d23b52844f6797e42db5b7512a9

comment:8 Changed 6 years ago by Owen Arnold

  • Blocking 10181 added

comment:9 Changed 6 years ago by Owen Arnold

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

Tester.

  • Stitch1DMD has been deprecated. We do not need to provide usage examples for deprecated algorithms
  • ConvertToReflectometryQ has a usage example/test now.
  • LoadReflTable has some better documentation as well as a usage example/test now.
  • PolarizationCorrection will be dealt with separately under #10181 as I need more information from instrument scientists for this.

comment:10 Changed 6 years ago by Michael Reuter

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

comment:11 Changed 6 years ago by Michael Reuter

You should make the deprecation for Stitch1DMD standout by using a warning block.

comment:12 Changed 6 years ago by Michael Reuter

  • Status changed from verifying to reopened
  • Resolution fixed deleted

Adding the above would be beneficial to getting the point across. Otherwise, things look fine.

comment:13 Changed 6 years ago by Harry Jeffery

LoadReflTBL has changed within develop as a result of #9473. The doc test is now failing.

comment:14 Changed 6 years ago by Harry Jeffery

  • Status changed from reopened to inprogress

refs #9916. Update LoadReflTbl test

Changeset: 64f200fc83016476ad0b97d8f674f7cd6aaa3ee4

comment:15 Changed 6 years ago by Nick Draper

Moved to the backlog at the code freeze of R3.3

comment:16 Changed 6 years ago by Nick Draper

  • Milestone changed from Release 3.3 to Backlog

comment:17 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10758

Note: See TracTickets for help on using tickets.