Ticket #2281 (closed: fixed)

Opened 10 years ago

Last modified 5 years ago

Add python docs to algorithm binding

Reported by: Peter Peterson Owned by: Peter Peterson
Priority: minor Milestone: Iteration 27
Component: Mantid Keywords:
Cc: doucetm@… Blocked By:
Blocking: Tester: Martyn Gigg

Description

In order to simplify the document generation for algorithms as python functions, add functionality to the appropriate parts of the python API to do the work in stead.

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

(In [8933]) Exposed a method for creating function docs in python. Refs #2281.

comment:3 Changed 10 years ago by Mathieu Doucet

  • Cc doucetm@… added

comment:4 Changed 10 years ago by Mathieu Doucet

The createAlgorithmDocs is exposed to python, but it's not very easy to use: 

l = Load(None, None, execute=None)
print mtd.createAlgorithmDocs(l._getHeldObject())

Since the method expects an IAlgorithm object, you have to create the algorithm object first and know how to access it.

comment:5 Changed 10 years ago by Peter Peterson

(In [9022]) Call the document generating function explicitely in mantidsimple. Refs #2281.

comment:6 Changed 10 years ago by Russell Taylor

(In [9029]) Comment out failing part of test pending Pete's attention first thing Monday :). Re #2281.

comment:7 Changed 10 years ago by Peter Peterson

(In [9063]) Removed test that is no longer valid. Refs #2281.

comment:8 Changed 10 years ago by Peter Peterson

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

comment:9 Changed 10 years ago by Martyn Gigg

  • Status changed from verify to verifying
  • Tester set to Martyn Gigg

comment:10 Changed 10 years ago by Martyn Gigg

  • Status changed from verifying to closed

Confirmed that the help strings are generated on the fly and are correct.

comment:11 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​3128

Note: See TracTickets for help on using tickets.