Ticket #10077 (new)

Opened 6 years ago

Last modified 5 years ago

Check Code Documentation and add Usage Examples for 4 Crystal Algorithms

Reported by: Karl Palmen Owned by:
Priority: critical Milestone: Release 3.5
Component: Documentation Keywords:
Cc: anders.markvardsen@… Blocked By:
Blocking: Tester:


Please check the documentation for these algorithms (check images, formatting etc) and add testable algorithm usage examples. We have tried to allocate algorithms as fairly and sensibly as possible, but there will be some that you do not consider "yours".

There is help on how to document the algorithms in the following links: http://www.mantidproject.org/Algorithm_Documentation http://www.mantidproject.org/Algorithm_Usage_Examples And there are examples implemented for Fit, Load, LoadISISNexus and Rebin.


To create workspaces to use in your usages you should try to create the workspace using CreateSampleWorkspace or CreateWorkspace, and only use a file if you really have no other option and the size is small.

In Visual studio you have two targets to create the documentation and run the doc tests (docs-html and docs-test in a documentation subfolder). You will need to update your Third Party Library.

If you are using Linux/Mac look here: ​​https://github.com/mantidproject/mantid/blob/master/Code/Mantid/docs/README.md

Change History

comment:1 Changed 6 years ago by Owen Arnold

  • Status changed from new to assigned

comment:2 Changed 6 years ago by Karl Palmen

  • Blocking 9726 added

Work on ClearUB has been completed in the branch of #9726, so should not be done here.

comment:3 Changed 6 years ago by Karl Palmen

IndexPeaks has also been done in #9726.

comment:4 Changed 6 years ago by Karl Palmen

  • Blocking 9726 removed

All four usage examples have been dealt with in #9726. This ticket can be resolved as duplicate after #9726 has been closed.

comment:5 Changed 6 years ago by Nick Draper

  • Status changed from assigned to new
  • Milestone changed from Release 3.3 to Release 3.4

comment:6 Changed 5 years ago by Nick Draper

  • Milestone changed from Release 3.4 to Release 3.5

Moved to R3.5 at the end of R3.4

comment:7 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10919

Note: See TracTickets for help on using tickets.