Ticket #9580 (closed: fixed)
Check Documentation and add algorithm usage examples
Reported by: | Nick Draper | Owned by: | Michael Reuter |
---|---|---|---|
Priority: | critical | Milestone: | Release 3.2 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Tester: | Nick Draper |
Description (last modified by Michael Reuter) (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 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
- He3TubeEfficiency.cpp
- SaveMD.cpp
- ImportMDEventWorkspace.cpp
- ImportMDHistoWorkspace.cpp
- DgsAbsoluteUnitsReduction.cpp
- DgsConvertToEnergyTransfer.cpp
- DgsDiagnose.cpp
- DgsPreprocessData.cpp
- DgsProcessDetectorVanadium.cpp
- DgsReduction.cpp
- DgsRemap.cpp
- WeightedMeanOfWorkspace.cpp
- LoadMask.cpp
- BASISReduction.py
- ConvertSnsRoiFileToMask.py
- LoadNexusMonitors.cpp
Change History
comment:1 Changed 6 years ago by Nick Draper
- Status changed from new to assigned
- Owner changed from Roman Tolchenov to Michael Reuter
- Description modified (diff)
- Summary changed from Check Documentation and add algorithm usage examples (cloned) to Check Documentation and add algorithm usage examples
comment:4 Changed 6 years ago by Michael Reuter
Refs #9580. Adding 1 and 15.
Changeset: 41bf124c1be8a1b79501a978afd7d1ec0dec6bcf
comment:5 Changed 6 years ago by Michael Reuter
Refs #9580. Adding 3 and 16.
Changeset: babf583e1f856246e6889057623da5939ee8ea3f
comment:6 Changed 6 years ago by Michael Reuter
Refs #9580. Fixing usage data reference.
Changeset: cd3c66d41e27fddc773cffc11fd0ae0a4764b8a8
comment:7 Changed 6 years ago by Michael Reuter
Refs #9580. Adding 4 and 5.
Changeset: 193130c2970e39df7d9532c030a2e4a009e13009
comment:8 Changed 6 years ago by Michael Reuter
Refs #9580. Adding 18 and 28.
Changeset: 1237dc4f16b40cc55ef9a709be321d9e7c97b28b
comment:10 Changed 6 years ago by Michael Reuter
Refs #9580. Adding Dgs algorithms.
Changeset: e4196c96af44379ef66120c801cc83274e2779ae
comment:11 Changed 6 years ago by Michael Reuter
Refs #9580. Adding BASISReduction.
Changeset: 12146929eee76a80204aea4952dc6fc324df0c42
comment:12 Changed 6 years ago by Michael Reuter
The branch can be found here.
To Test: Run the docs-html and docs-test targets to see if things look good for the listed algorithms.
comment:13 Changed 6 years ago by Michael Reuter
- Status changed from inprogress to verify
- Resolution set to fixed
comment:14 Changed 6 years ago by Nick Draper
- Status changed from verify to verifying
- Tester set to Nick Draper
comment:15 Changed 6 years ago by Nick Draper
This is a really nice example of a job well done on the usage examples and algorithm doc checking.
Thanks Michael.
comment:16 Changed 6 years ago by Nick Draper
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9580_documentation'
Full changeset: b2df159c1d5ca785d3618e94186cf12629d10ce5
comment:17 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10423