Ticket #8595 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Description of new algorithm for step by step LeBailFit refinement is inadequate

Reported by: Alex Buts Owned by: Wenduo Zhou
Priority: major Milestone: Release 3.1
Component: Diffraction Keywords:
Cc: Blocked By:
Blocking: Tester: Nick Draper

Description

Every algorithm which appears in GUI should have a Wiki page and I have found nothing for the one created fir the ticket #8089. Not sure if wikimaker runs for Python code but even if it does, existing document string is inadequate. "Copy from Part 1 LeBailFit" is not a description

1) Algorithm description should contain brief purpose, list of parameters, acceptable parameters values, what is expected to obtain as the result.

2) User should be able to find the description of the columns in log table produced by the workflow algorithm and I was not able to find any.

3) The Optimization part of the LeBailFit description (http://www.mantidproject.org/LeBailFit#Optimization) has broken sentences. E.g. The experience to use non-linear minimizes such as Simplex or ... This also should be fixed for this ticket.

Change History

comment:1 Changed 7 years ago by Wenduo Zhou

  • Status changed from new to inprogress

comment:2 Changed 7 years ago by Wenduo Zhou

Added wiki to RefinePowderDiffProfileSeq. Refs #8595.

Changeset: 9e34beb6506c1d2cc0b940acba116b83ab95c71c

comment:3 Changed 7 years ago by Wenduo Zhou

Fixed wiki of LeBailFit. Refs #8595.

Changeset: 841b94066497b485cdf71e77beec48a43f60c2ae

comment:4 Changed 7 years ago by Wenduo Zhou

Rename python algorithm file name. Refs #8595.

Made python file name same as algorithm's name.

Changeset: c1d0ba1376cc779cbab635c59508193e45817582

comment:5 Changed 7 years ago by Wenduo Zhou

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

Hint to verify the ticket

The goal of this ticket is to add wiki page to algorithm RefinePowderDiffProfileSeq and correct the wiki page of LeBailFit. So their wiki pages should be checked. And it is also useful to check whether the wikimaker on Jenkins does not complain about these two algorithms.

comment:6 Changed 7 years ago by Nick Draper

  • Status changed from verify to verifying
  • Tester set to Nick Draper

comment:7 Changed 7 years ago by Nick Draper

tested by code review

comment:8 Changed 7 years ago by Nick Draper

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/8595_seqrefine_wiki'

Full changeset: 3efa2562a9a562325023ee515235201763f619bb

comment:9 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 9439

Note: See TracTickets for help on using tickets.