Check Documentation and Add Algorithm Usage Examples - Part 1 #10430
Labels
Documentation
Issues and pull requests related to documentation
High Priority
An issue or pull request that if not addressed is severe enough to postponse a release.
Milestone
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
SaveCanSAS1D.cppSaveNXSPE.cppSaveCanSAS1D2.cppRetrieveRunInfo.pySANSBeamFluxCorrection.cppCreateEmptyTableWorkspace.pySANSWideAngleCorrection.pyFindDetectorsInShape.cppLoadPreNexusMonitors.cppSaveNISTDAT.cppSaveRKH.cppUnwrapMonitor.cppLoadInstrumentFromRaw.cppLoadRawBin0.cppLoadInstrumentFromNexus.cppChopData.cppConvertSpectrumAxis.cppMergeRuns.cppLoadMuonLog.cppCreatePSDBleedMask.cpp[Already done elsewhere]FindCenterOfMassPosition2.cpp[Already done elsewhere]The rest have been moved to http://trac.mantidproject.org/mantid/ticket/9804.
The text was updated successfully, but these errors were encountered: