Ticket #9102 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Add Summary to Algorithms that have Description

Reported by: Karl Palmen Owned by: Karl Palmen
Priority: major Milestone: Release 3.2
Component: Framework Keywords: documentation
Cc: Blocked By:
Blocking: #8917 Tester: Arturs Bekasovs

Description

The following algorithms have no summary, but do have a description. A summary is needed for the GUI of the algorithm in Mantidplot.

  • ConvertInstrumentFile
  • GetTimeSeriesLogInformation
  • RefLReduction
  • SANSMask
  • Stitch1D
  • Stitch1DMany
  • SuggestTibCNCS
  • SuggestTibHYSPEC
  • TestWorkspaceGroupProperty

Add summary based on description.

Attachments

list9102a.txt (702 bytes) - added by Karl Palmen 7 years ago.

Change History

comment:1 Changed 7 years ago by Nick Draper

  • Status changed from new to assigned

comment:2 Changed 7 years ago by Karl Palmen

  • Status changed from assigned to inprogress

Give Summary to algorithm found in c++ code re #9102

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 257097084db59aa54f02aea96cf28057d9f51fba

comment:3 Changed 7 years ago by Karl Palmen

Add summaries to python algorithms re #9102

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: bf2f8119ab42741dd98eac26d6111c3dc25c32c5

comment:4 Changed 7 years ago by Karl Palmen

I thought that setWikiSummary() also set the message at the top of the GUI, but this appears to be set by a setOtionalMessage().

This implies that the list of algorithms for this ticket is not valid and may put this ticket out of the scope of #8917, which spawned it.

comment:5 Changed 7 years ago by Karl Palmen

A talk with Nick Draper confirmed that this ticket is in scope, so work will progress.

comment:6 Changed 7 years ago by Karl Palmen

This has lead to an expainsion of the set of applicable algorithms. This includes most Python algorithms. I attach the list in list9102.txt.

C++ algorithms have not been checked. Any needing a GUI header would be dealt in another ticket to limit the testing burden of this ticket.

Changed 7 years ago by Karl Palmen

comment:7 Changed 7 years ago by Karl Palmen

Modify numerous python algorithms re #9102

Also correct spelling in CopyLogs.cpp .

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 5419dd0ee08e6989c321ee40a7aea818367477fb

comment:8 Changed 7 years ago by Karl Palmen

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

To test run Mantid and execute each of the algorithms in the attached list9102a.txt file to get its dialog box. Check that there is a summary at the top of the dialog box and it is OK, then cancel.

I have not added a wiki summary to all of these, because I think it would look bad, if it was the same or very similar to the descruption.

comment:9 Changed 7 years ago by Arturs Bekasovs

  • Status changed from verify to verifying
  • Tester set to Arturs Bekasovs

comment:10 Changed 7 years ago by Arturs Bekasovs

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9102_add_summary'

Full changeset: 2eda20cd738eab06b9ceb9a7683ffd49d26aa9b2

comment:11 Changed 7 years ago by Arturs Bekasovs

Went through all the algorithms in the list and they all appear to have yellow summary box at the top of the dialog. Descriptions all seem to be related to what every particular algorithm is doing.

comment:12 Changed 7 years ago by Nick Draper

  • Keywords SSC removed

comment:13 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 9945

Note: See TracTickets for help on using tickets.