Ticket #6628 (closed: invalid)

Opened 8 years ago

Last modified 5 years ago

Algorithm Usage

Reported by: Owen Arnold Owned by: Owen Arnold
Priority: critical Milestone: Release 2.5
Component: Mantid Keywords:
Cc: Blocked By:
Blocking: #6147 Tester: Michael Reuter

Description

In order to support the requested features #6147. We will need to separate a useage section from the description section for each algorithm.

  • Algorithm.h will need setWikiUsage & getWikiUsage
  • Old and new Python API will need to support these methods
  • All of the above will need to have unit tests
  • The wikimaker will need to be setup to read comments bewtween *WIKI_USAGE and /*WIKI_USAGE
  • The wikimaker will need to extract this section (or read it from the binaries).

I'm not going to handle the automatic usage documentation case under this ticket, but that will need to be done under another ticket.

Change History

comment:1 Changed 8 years ago by Owen Arnold

  • Priority changed from major to critical
  • Blocking 6147 added

comment:2 Changed 8 years ago by Owen Arnold

  • Owner set to Owen Arnold
  • Status changed from new to accepted

comment:3 Changed 8 years ago by Owen Arnold

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

The 'usage section' that was requested is really just the function signature as expressed in python. This will be done against the main ticket #6147. We do not (at least yet) need a separate wiki section for the algorithm by algorithm usage. This can just be appended onto the usual wiki section in the .py and .cpp files.

comment:4 Changed 8 years ago by Michael Reuter

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

comment:5 Changed 8 years ago by Michael Reuter

  • Status changed from verifying to closed

Looks like the work is to be done elsewhere.

comment:6 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​7474

Note: See TracTickets for help on using tickets.