Ticket #9627 (closed: fixed)
Check Documentation and add algorithm usage examples
Reported by: | Martyn Gigg | Owned by: | Nick Draper |
---|---|---|---|
Priority: | blocker | Milestone: | Release 3.2 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | #9653 | Tester: | Owen Arnold |
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 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
- SuggestTibCNCS.py
- SuggestTibHYSPEC.py
- TestWorkspaceGroupProperty.py - only used for testing - no example needed
- UpdatePeakParameterTableValue.py
- CreatePeaksWorkspace.cpp
- IdentifyNoisyDetectors.cpp
- OneMinusExponentialCor.cpp
- SANSDirectBeamScaling.cpp - unused alg may be removed
- StripVanadiumPeaks.cpp - two versions
- LoadLOQDistancesFromRaw.cpp - unused alg to be removed
- LoadSampleDetailsFromRaw.cpp
- AnvredCorrection.cpp
- FindUBUsingMinMaxD.cpp
- MaskPeaksWorkspace.cpp - very complex setup or large files - code block only
- OptimizeCrystalPlacement.cpp
- OptimizeLatticeForCellType.cpp
- PredictFractionalPeaks.cpp - code block only ticket 9642 created
- TransformHKL.cpp
- FindReflectometryLines.py
- LoadLogPropertyTable.py
- MonteCarloAbsorption.cpp
These are the leftovers from #9574.
Change History
comment:3 Changed 6 years ago by Nick Draper
re #9627 done algorithms 1-5
Changeset: e52eea5b9323908db9736e297429fdcf72123f97
comment:4 Changed 6 years ago by Nick Draper
- Status changed from new to assigned
- Description modified (diff)
comment:7 Changed 6 years ago by Nick Draper
re #9627 done up to algorithm number 10, next is 11
Changeset: a76eb8dbc129fc43c2b29958ae1b106c950e47f3
comment:8 Changed 6 years ago by Nick Draper
re #9627 Done up to and including 11
Changeset: 90b4bad14ca28791d0e293bd6831cc141857cedd
comment:9 Changed 6 years ago by Nick Draper
re #9627 done algs up to and including 18
Changeset: de7d2f5f0392dceb0154e4b2142b5d44eeb2bf4c
comment:10 Changed 6 years ago by Nick Draper
re #9627 Completed all of the algorithms but bear in mind the comments
Changeset: b93674fe2e78730b4d4e7611adabc716777be29d
comment:11 Changed 6 years ago by Nick Draper
re #9627 Revert a change to use an interface that failed a unit test
Changeset: dd1fb0043295e8f6115a1ae583a72a5845dfaa2a
comment:12 Changed 6 years ago by Nick Draper
- Status changed from inprogress to verify
- Resolution set to fixed
- Description modified (diff)
to test:
- Check that the Rhel6 build incremental develop passed - therefore no doctest failures
- check the html pages
comment:13 Changed 6 years ago by Owen Arnold
- Status changed from verify to verifying
- Tester set to Owen Arnold
comment:14 Changed 6 years ago by Nick Draper
re #9627 resolve comment warnings
Changeset: f7a518af16fed8fd83dc9d60202bddf95a9d841e
comment:15 Changed 6 years ago by Owen Arnold
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9627_Doc_Martyn'
Full changeset: 2f39c00f72b596da62ed8dabd6f4737e406b7d4b
comment:17 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10470