Ticket #7096 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Improve documentation of FindUBUsingLatticeParameters

Reported by: Peter Peterson Owned by: Dennis Mikkelson
Priority: major Milestone: Release 2.6
Component: Diffraction Keywords:
Cc: Blocked By:
Blocking: Tester: Dereck Kachere

Description

In the wiki documentation, explain what how the Tolerance is used in the algorithm. The current tooltip is good, but the full documentation should explain if it is a tolerance in the hkls or lattice constants.

Change History

comment:1 Changed 7 years ago by Dennis Mikkelson

  • Status changed from new to accepted

comment:2 Changed 7 years ago by Dennis Mikkelson

RE 7096 Improve docs for FindUBUsingLatticeParameters

Added more details on the algorithm calculations and the parameters Tolerance and NumInitial.

refs #7096

Changeset: 8d5d0226ba02bdd0669b5a88521f5ce675c1823d

comment:3 Changed 7 years ago by Dennis Mikkelson

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

NOTES to tester:

  1. The branch name is feature/7096_Improve_docs_for_FindUBUsingLatticeParameters
  2. Only the comments at the start of the FindUBUsingLatticeParameters.cpp file were changed, so I did NOT merge this with develop and push it to the build servers.
  3. Wiki_maker was used to put the new docs on the Mantid website.

comment:4 Changed 7 years ago by Dereck Kachere

  • Status changed from verify to verifying
  • Tester set to Dereck Kachere

comment:5 Changed 7 years ago by Dennis Mikkelson

RE 7096 Improve docs for FindUBUsingLatticeParameters

Added more details on the algorithm calculations and the parameters Tolerance and NumInitial.

refs #7096

Changeset: 8d5d0226ba02bdd0669b5a88521f5ce675c1823d

comment:6 Changed 7 years ago by Dennis Mikkelson

RE 7096 Improve docs for FindUBUsingLatticeParameters

Added more details on the algorithm calculations and the parameters Tolerance and NumInitial.

refs #7096

Changeset: 8d5d0226ba02bdd0669b5a88521f5ce675c1823d

comment:7 Changed 7 years ago by Dereck Kachere

  • Status changed from verifying to closed

Merged commits into develop on developer's behalf.

Even though the changes were only in the comments of the file and it was by choice that commits were not merged into develop, please follow workflow in future. Life is much easier when using the testing macros. More importantly, it ensures that the file history can be traced properly.

comment:8 Changed 7 years ago by Owen Arnold

Merge branch 'master' into feature/7069_conjoin_spectra into 7090_runpythonscript

comment:9 Changed 7 years ago by Nick Draper

  • Component changed from Mantid to Framework

comment:10 Changed 7 years ago by Nick Draper

  • Component changed from Framework to Diffraction

comment:11 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 7942

Note: See TracTickets for help on using tickets.