Ticket #1417 (closed: fixed)

Opened 10 years ago

Last modified 5 years ago

Algorithms should have regular python documentation

Reported by: Peter Peterson Owned by: Peter Peterson
Priority: minor Milestone: Iteration 24
Component: Keywords:
Cc: Blocked By:
Blocking: Tester: Michael Whitty

Description

While the formatting of mantidHelp is pretty, most people will use python's built-in help function. Generate documentation for it.

Change History

comment:1 Changed 10 years ago by Peter Peterson

  • Status changed from new to accepted
  • Owner set to Peter Peterson

comment:2 Changed 10 years ago by Peter Peterson

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

(In [5320]) Autogenerate python docs from inspecting the properties. This could share more from the mtdHelp generation, but it gets the job done. Fixes #1417.

comment:3 Changed 10 years ago by Martyn Gigg

  • Status changed from closed to reopened
  • Resolution fixed deleted

comment:4 Changed 10 years ago by Martyn Gigg

(In [5323]) Fix a test. Re #1417

comment:5 Changed 10 years ago by Martyn Gigg

  • Status changed from reopened to testing
  • Resolution set to fixed

comment:6 Changed 10 years ago by Nick Draper

  • Status changed from testing to verify

Moved to verify state

comment:7 Changed 10 years ago by Michael Whitty

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

comment:8 Changed 10 years ago by Michael Whitty

  • Status changed from verifying to closed

working in 5911

comment:9 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​2264

Note: See TracTickets for help on using tickets.