Ticket #7915 (assigned)

Opened 7 years ago

Last modified 5 years ago

Python Documentation and Methods

Reported by: Owen Arnold Owned by: Nick Draper
Priority: critical Milestone: Backlog
Component: Framework Keywords:
Cc: Blocked By:
Blocking: Tester:

Description (last modified by Owen Arnold) (diff)

This issue was a suggestion by Emanuel. Reassign as appropriate after checking the validity of this issue.

Some documentation is completely lacking from the python documentation, in other cases the function naming convention is not consistent. For example, compare http://download.mantidproject.org/docs/current-release/python/html/api/generated/InstrumentWindow.html?highlight=colormap#mantidplot.InstrumentWindow.changeColormap (mixed case) with

inst = getInstrumentView('x')
tab = inst.getTab(InstrumentWindow.RENDER)

which is camel case (correct)

I suggest that the following things need to be addressed:

  • Documentation completely missing from many functions, what do they do?
  • Inconsistent cases (changeColourMap vs changeColormap)
  • Inconsistent access to plotting i.e. plotSpectrum, plotBin, plotSlice, but getInstrumentView!
  • getInstrumentView only takes the workspace name, not the workspace itself. other plotting functions can handle both.

Apologies for writing an umbrella ticket for all these issues, should probably be resolved as separate issues.

Change History

comment:1 Changed 7 years ago by Owen Arnold

  • Description modified (diff)

comment:2 Changed 7 years ago by Nick Draper

  • Status changed from new to assigned

Bulk move to assigned at the introduction of the triage step

comment:3 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 8760

Note: See TracTickets for help on using tickets.