Context Navigation

← Previous Ticket
Next Ticket →

Ticket #9588 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Check Documentation and add algorithm usage examples

Reported by:	Nick Draper	Owned by:	Ricardo Leal
Priority:	critical	Milestone:	Release 3.2
Component:	Documentation	Keywords:
Cc:		Blocked By:
Blocking:		Tester:	Nick Draper

Description (last modified by Nick Draper) (diff)

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, DiffractionFocussing 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

CorrectFlightPaths.cpp

Change History

comment:1 Changed 6 years ago by Nick Draper

Status changed from new to assigned
Owner changed from Peter Parker to Ricardo Leal
Description modified (diff)
Summary changed from Check Documentation and add algorithm usage examples (cloned) to Check Documentation and add algorithm usage examples