Ticket #8782 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

wiki_usage not parsed for offline help

Reported by: Andrei Savici Owned by: Andrei Savici
Priority: major Milestone: Release 3.1
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: Tester: Wenduo Zhou

Description (last modified by Andrei Savici) (diff)

Some algorithms contain a wiki_usage section. It does not show up in the offline help. Several examples: ImportMDEventWorkspace, SortPeaksWorkspace

Change History

comment:1 Changed 7 years ago by Andrei Savici

  • Status changed from new to inprogress

Added wiki_usage parsing to offline help for algorithms. Refs #8782

Changeset: 606b1d88ec85069d0b4e7dcac0dc95885fe86829

comment:2 Changed 7 years ago by Andrei Savici

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

The wiki_usage section is included as preformatted text. If ticket #8781 is fixed, remove the pre tags from line 131 in algorithm_help.py 

text+="<pre>"+custom_usage+ "</pre>"

To test, build qtassistant on branch feature/8782_qtassistant_wiki_usage and see if more information is included in the above examples

comment:3 Changed 7 years ago by Andrei Savici

  • Description modified (diff)

comment:4 Changed 7 years ago by Wenduo Zhou

  • Status changed from verify to verifying
  • Tester set to Wenduo Zhou

comment:5 Changed 7 years ago by Nick Draper

  • Component changed from Framework to Documentation

comment:6 Changed 7 years ago by Wenduo Zhou

Test is passed.

comment:7 Changed 7 years ago by Wenduo Zhou

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/8782_qtassistant_wiki_usage'

Full changeset: ​4847daf93eb041378e1b4145d35f69117025af40

comment:8 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​9626

Note: See TracTickets for help on using tickets.