Ticket #8211 (closed: wontfix)

Opened 7 years ago

Last modified 5 years ago

Fix method signature of MantidPlot objects as shown by IPython pop-up doc windows.

Reported by: Russell Taylor Owned by: Russell Taylor
Priority: major Milestone: Release 3.2
Component: GUI Keywords: IPython
Cc: Blocked By:
Blocking: Tester: Vickie Lynch

Description (last modified by Russell Taylor) (diff)

#4311 fixed things so you can see the docstring of our wrapped (by QtProxyObject) MantidPlot python objects. However, the signature always shows as (*args, **kwargs) - the signature of the CrossThreadCall dispatch method. If the docstring was auto-generated by sip, you do see the real signature below, but it would be nice to fix this.

This should be possible in a manner similar to that in which the Mantid algorithm signatures are fixed up. The place to look is line 556 of simpleapi.py. We would have to use the inspect module to figure out the real signature and reform a "new" function object.

Change History

comment:1 Changed 7 years ago by Russell Taylor

  • Description modified (diff)

comment:2 Changed 7 years ago by Russell Taylor

  • Milestone changed from Release 3.1 to Backlog

comment:3 Changed 7 years ago by Russell Taylor

  • Milestone changed from Backlog to Release 3.2

comment:4 Changed 7 years ago by Nick Draper

  • Status changed from new to assigned

Bulk move of tickets out of triage (new) to assigned at the introduction of the triage state

comment:5 Changed 6 years ago by Russell Taylor

  • Status changed from assigned to verify
  • Resolution set to wontfix

I don't think this is a big deal. There are much bigger fish to fry (and lots of them).

comment:6 Changed 6 years ago by Vickie Lynch

  • Status changed from verify to verifying
  • Tester set to Vickie Lynch

comment:7 Changed 6 years ago by Vickie Lynch

  • Status changed from verifying to closed

comment:8 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 9056

Note: See TracTickets for help on using tickets.