Ticket #7273 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Add list of aliases to algorithm help description

Reported by: Peter Peterson Owned by: Peter Peterson
Priority: major Milestone: Release 2.6
Component: Documentation Keywords:
Cc: owen.arnold@… Blocked By:
Blocking: Tester: Mathieu Doucet

Description

Some algorithms have aliases. Just above the "Properties" table, add a list of aliases if there are any. Also add them to the index of algorithms in qtassistant with links to the "real" name of the algorithm.

Change History

comment:1 Changed 7 years ago by Peter Peterson

  • Status changed from new to accepted
  • Cc owen.arnold@… added

comment:2 Changed 7 years ago by Peter Peterson

Re #7273. Adding alias section if the algorithm has one.

Changeset: d65b621e875b933ee4edb94e55bff0e3ebdb9a37

comment:3 Changed 7 years ago by Peter Peterson

Re #7273. Adding algorithm alias to qhp index.

Changeset: 1bbea4cbf68a73ef014b6ff9810bcf1284b6cd8f

comment:4 Changed 7 years ago by Peter Peterson

Re #7273. Adding aliases to qtassistant algorithm indices.

Changeset: 9500e8b2566b254c087e3f538d4bf688f7e4b18b

comment:5 Changed 7 years ago by Peter Peterson

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

This is on feature/7273_aliases_in_help.

To check the best thing to do is "make qtassistant" and look for UpdateInstrumentFromRaw which is an alias for UpdateInstrumentFromFile. You can look for other things as well, but one should do.

comment:6 Changed 7 years ago by Mathieu Doucet

  • Status changed from verify to verifying
  • Tester set to Mathieu Doucet

comment:7 Changed 7 years ago by Mathieu Doucet

  • Status changed from verifying to closed

Works as advertised.

comment:8 Changed 7 years ago by Nick Draper

  • Component changed from Mantid to Framework

comment:9 Changed 7 years ago by Nick Draper

  • Component changed from Framework to Documentation

comment:10 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 8119

Note: See TracTickets for help on using tickets.