Ticket #9533 (closed: fixed)
Usage example for Fit and DiffractionFocussing algorithms
| Reported by: | Anders Markvardsen | Owned by: | Anders Markvardsen |
|---|---|---|---|
| Priority: | major | Milestone: | Release 3.2 |
| Component: | Documentation | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | #8919 | Tester: | Nick Draper |
Description
Usage example for Fit and DiffractionFocussing algorithms. These where marked as example of different type of algorithms to create example usage examples for
Attachments
Change History
comment:1 Changed 6 years ago by Anders Markvardsen
- Status changed from new to assigned
- type changed from enhancement to task
comment:2 Changed 6 years ago by Anders Markvardsen
temporary repository, https://github.com/Anders-Markvardsen/sphinxDocTest added for the purpose of setting up usage examples.
.rst for the usage examples for DiffractionFocussing and Fit can be found in https://github.com/Anders-Markvardsen/sphinxDocTest/tree/master/source/Algorithms/doc
Attached are HTML output of these usage examples.
Fit uses CreateSampleWorkspace to create a workspace, but it is here suggested that an usage example for DiffractionFocussing loads a real dataset.
Usage data are available from https://github.com/mantidproject/usagedata
To test:
Agree that the usage examples are acceptable
comment:3 Changed 6 years ago by Anders Markvardsen
- Status changed from assigned to verify
- Resolution set to fixed
note info for how usage example fit in with alg doc pages in generasl: http://www.mantidproject.org/Algorithm_Usage_Examples
