Ticket #7260 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Add documentation to SANSSubtract

Reported by: Mathieu Doucet Owned by: Mathieu Doucet
Priority: major Milestone: Release 2.6
Component: SANS Keywords:
Cc: Blocked By: #7235
Blocking: Tester: Michael Reuter

Description (last modified by Nick Draper) (diff)

Some SANS algorithms have no documentation, which means that hitting the '?' button fails.

Add docs to the following:

  • SANSSubtract
  • EQSANSTransmission (will be removed by #7235)
  • EQSANSMonitorTOF

Change History

comment:1 Changed 7 years ago by Mathieu Doucet

  • Status changed from new to accepted

comment:2 Changed 7 years ago by Mathieu Doucet

  • Description modified (diff)
  • Blocked By 7235 added

comment:3 Changed 7 years ago by Mathieu Doucet

To test:

Check that both the algorithm dialog and the docs you get after hitting the '?' are present for the following algorithms:

  • SANSSubtract
  • EQSANSMonitorTOF
  • HFIRSANSReduction
  • NormaliseByThickness
  • EQSANSAzimuthalAverage1D
  • EQSANSDirectBeamTransmission
  • EQSANSNormalise
  • ReactorSANSResolution
  • SANSAbsoluteScale
  • SANSAzimuthalAverage1D
  • SANSBeamSpreaderTransmission
  • SANSDirectBeamTransmission
  • SANSReduction

comment:4 Changed 7 years ago by Mathieu Doucet

Re #7260 Added docs and setOptionalMessage to PythonAlgorithm

Changeset: 90c0e52dea0a91d5bfbb27de613ccbfeae54032f

comment:5 Changed 7 years ago by Mathieu Doucet

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

comment:6 Changed 7 years ago by Michael Reuter

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

comment:7 Changed 7 years ago by Michael Reuter

  • Status changed from verifying to closed

Everything seems to be in good order here.

comment:8 Changed 7 years ago by Nick Draper

  • Component changed from Mantid to Framework

comment:9 Changed 7 years ago by Nick Draper

  • Component changed from Framework to SANS
  • Description modified (diff)

comment:10 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​8106

Note: See TracTickets for help on using tickets.