Ticket #6751 (closed: fixed)

Opened 8 years ago

Last modified 5 years ago

Organize the documentation of some algorithms

Reported by: Gesner Passos Owned by: Nick Draper
Priority: critical Milestone: Release 2.5
Component: Mantid Keywords:
Cc: Blocked By: #6685
Blocking: Tester: Owen Arnold

Description (last modified by Owen Arnold) (diff)

The wiki_maker will now be responsible for generating the wiki pages for the algorithms, and it will generate only one page per algorithm, the page for the last (and current) algorithm. So, it is necessary to ensure that the documentation of each algorithm is inside the correct file, to ensure that the documentation generated will be ok.

This is a list (not sure if complete) of Algorithms whose documentation is not inside the correct files:

  • LoadRaw
  • GroupDetectors
  • LoadMuonNexus
  • FFTSmooth
  • InvertMask
  • Q1D
  • DiffractionFocussing
  • FindCenterOfMassPosition
  • RefinePowderInstrumentParameters
  • FitPowderDiffPeaks
  • RefinePowderInstrumentParameters
  • GaussianLinearBG1D

Implementor, you must wait until changes in 6685 are available on Master before doing this work

Change History

comment:1 Changed 8 years ago by Owen Arnold

  • Blocking 6685 removed

comment:2 Changed 8 years ago by Owen Arnold

  • Blocked By 6685 added

comment:3 Changed 8 years ago by Owen Arnold

  • Description modified (diff)

comment:4 Changed 8 years ago by Nick Draper

RefinePowderInstrumentParameters is so important it was listed twice!

GaussianLinearBG1D is a deprecated algorithm.

Others updated.

comment:5 Changed 8 years ago by Nick Draper

re #6751 updated location of algorithm comments to the latest versions

Changeset: b05747e52ece97c752cc2c35d2c82bf6413c0a93

comment:6 Changed 8 years ago by Nick Draper

re #6751 updated location of algorithm comments to the latest versions

Changeset: b05747e52ece97c752cc2c35d2c82bf6413c0a93

comment:7 Changed 8 years ago by Nick Draper

  • Owner changed from Owen Arnold to Nick Draper
  • Status changed from new to accepted

comment:8 Changed 8 years ago by Nick Draper

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

comment:9 Changed 8 years ago by Owen Arnold

  • Status changed from verify to verifying
  • Tester set to Owen Arnold

comment:10 Changed 8 years ago by Nick Draper

re #6751 updated location of algorithm comments to the latest versions

Changeset: b05747e52ece97c752cc2c35d2c82bf6413c0a93

comment:11 Changed 8 years ago by Owen Arnold

  • Status changed from verifying to closed

comment:12 Changed 8 years ago by Nick Draper

re #6751 updated location of algorithm comments to the latest versions

Changeset: b05747e52ece97c752cc2c35d2c82bf6413c0a93

comment:13 Changed 8 years ago by Nick Draper

re #6751 updated location of algorithm comments to the latest versions

Changeset: b05747e52ece97c752cc2c35d2c82bf6413c0a93

comment:14 Changed 7 years ago by Nick Draper

re #6751 updated location of algorithm comments to the latest versions

Changeset: b05747e52ece97c752cc2c35d2c82bf6413c0a93

comment:15 Changed 7 years ago by Nick Draper

re #6751 updated location of algorithm comments to the latest versions

Changeset: b05747e52ece97c752cc2c35d2c82bf6413c0a93

comment:16 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​7597

Note: See TracTickets for help on using tickets.