Ticket #9574 (closed: fixed)
Check Documentation and add algorithm usage examples
Reported by: | Nick Draper | Owned by: | Martyn Gigg |
---|---|---|---|
Priority: | critical | Milestone: | Release 3.2 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Tester: | Peter Peterson |
Description (last modified by Martyn Gigg) (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
UpdateScriptRepository.cppNormaliseByPeakArea.cppDeleteWorkspace.cppPower.cppMean.pyCreateSingleValuedWorkspace.cppLoadVesuvio.pyCalculateGammaBackgroundInterpolatingRebin.cppPolynomialCorrection.cppConvertSpectrumAxis2.cpp- SuggestTibCNCS.py
- SuggestTibHYSPEC.py
- TestWorkspaceGroupProperty.py
- UpdatePeakParameterTableValue.py
- CreatePeaksWorkspace.cpp
- IdentifyNoisyDetectors.cpp
- OneMinusExponentialCor.cpp
- SANSDirectBeamScaling.cpp
- StripVanadiumPeaks.cpp
- LoadLOQDistancesFromRaw.cpp
- LoadSampleDetailsFromRaw.cpp
- AnvredCorrection.cpp
- FindUBUsingMinMaxD.cpp
- MaskPeaksWorkspace.cpp
- OptimizeCrystalPlacement.cpp
- OptimizeLatticeForCellType.cpp
- PredictFractionalPeaks.cpp
- TransformHKL.cpp
- FindReflectometryLines.py
- LoadLogPropertyTable.py
- MonteCarloAbsorption.cpp
Change History
comment:1 Changed 6 years ago by Nick Draper
- Owner changed from Wenduo Zhou to Martyn Gigg
- Status changed from new to assigned
- 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 Martyn Gigg
- Status changed from assigned to inprogress
Update documentation & add usage for UpdateScriptRepository
Refs #9574
Changeset: 0110c83803fa730c9f82b97a5493eeed52103263
comment:5 Changed 6 years ago by Martyn Gigg
Implement usage for NormaliseByPeakArea
Also clarify a property description Refs #9574
Changeset: 23ec6429569b863ee2e71f8bf9f78fa195c8f55b
comment:6 Changed 6 years ago by Martyn Gigg
Remove unrequired testcleanup sections
Refs #9574
Changeset: aef06180361ba1c0cfcecafe0ec8de9135d149cc
comment:8 Changed 6 years ago by Martyn Gigg
Add hidden toctree to index.rst
This squashes all of the warnings about most documents not in a toctree. Refs #9574
Changeset: ab48ac0098251f55d4da3ed60bf3e0547d2e9f96
comment:9 Changed 6 years ago by Martyn Gigg
Add usage examples to DeleteWorkspace.
Refs #9574
Changeset: 38fe50272c2de9dc9797935df5982b9193c5abac
comment:10 Changed 6 years ago by Martyn Gigg
- Description modified (diff)
ViewBOA will be handled in #9589
comment:12 Changed 6 years ago by Martyn Gigg
Add reference to t0 parameter in NormaliseByPeakArea.
Refs #9574
Changeset: 3b5290c2c9a69479cf35fc77e09780ad96bdd098
comment:13 Changed 6 years ago by Martyn Gigg
comment:14 Changed 6 years ago by Martyn Gigg
Update documentation of Mean and add a usage test.
Refs #9574
Changeset: 93442245565193ce1d9cd31fed345d56f5dfe609
comment:16 Changed 6 years ago by Martyn Gigg
- Status changed from inprogress to verify
- Resolution set to fixed
- Description modified (diff)
comment:18 Changed 6 years ago by Martyn Gigg
Improve CreateSingleValuedWorkspace docs and add usage tests.
Refs #9574
Changeset: 7698532d12d1296f17e1d131c997e715bbe1e492
comment:19 Changed 6 years ago by Martyn Gigg
comment:20 Changed 6 years ago by Martyn Gigg
Update documentation & add usage for UpdateScriptRepository
Refs #9574
Changeset: a367dcfdbbe0c9951184257ccc533b58297bb480
comment:21 Changed 6 years ago by Martyn Gigg
Implement usage for NormaliseByPeakArea
Also clarify a property description Refs #9574
Changeset: d0d0109d43f69556d6c0652267bc6da01899ca11
comment:22 Changed 6 years ago by Martyn Gigg
Remove unrequired testcleanup sections
Refs #9574
Changeset: c404ad585010047a56f63b76c1fbd6c00eed8279
comment:23 Changed 6 years ago by Martyn Gigg
Add hidden toctree to index.rst
This squashes all of the warnings about most documents not in a toctree. Refs #9574
Changeset: 65d15d94645531aa7344f6df03e0492169c25228
comment:24 Changed 6 years ago by Martyn Gigg
Add usage examples to DeleteWorkspace.
Refs #9574
Changeset: 1b41d28acb0d4d6350694d709797ab979efba0a7
comment:25 Changed 6 years ago by Martyn Gigg
Add reference to t0 parameter in NormaliseByPeakArea.
Refs #9574
Changeset: 97959e0971e813d007473249b481e2d0cd25975a
comment:26 Changed 6 years ago by Martyn Gigg
comment:27 Changed 6 years ago by Martyn Gigg
Update documentation of Mean and add a usage test.
Refs #9574
Changeset: ef7ef4d4222450de59d46931b3e0e8d2a2eeab8d
comment:28 Changed 6 years ago by Martyn Gigg
Improve CreateSingleValuedWorkspace docs and add usage tests.
Refs #9574
Changeset: 6a969e2ea15c825bfe6093eb48be270abfacfdc3
comment:29 Changed 6 years ago by Martyn Gigg
comment:30 Changed 6 years ago by Martyn Gigg
Usage examples for CalculateGammaBackground.
Refs #9574
Changeset: 7024251ade4413d6ef1e0178e7f8b2669e4957fa
comment:31 Changed 6 years ago by Martyn Gigg
Ignore before comment 20 due to a rebase with master
comment:35 Changed 6 years ago by Martyn Gigg
Rebin parameters don't all apply to InterpolatingRebin
Also amalgamates code to accept single bin width as input rebin parameter. Refs #9574
Changeset: 13540f0257b26917593a415ba554c59dffe74c1e
comment:36 Changed 6 years ago by Martyn Gigg
Usage example for InterpolatingRebin.
Also updated Rebin documentation to provide linkable content so that InterpolatingRebin can refer to it. Refs #9574
Changeset: c8bb5d5a5ca45244b45371aacc3b0bccac902414
comment:37 Changed 6 years ago by Martyn Gigg
Centre out-of-line equations on their line.
The css that should do this in basic.css doesn't work with the bootstrap theme as it has an extra div.body tag on the section containing "text-align: center" so that it doesn't match in the bootstrap theme. Refs #9574
Changeset: 33ae9bbde30f5a4329c9826ac32e16dd4874067c
comment:38 Changed 6 years ago by Martyn Gigg
Usage examples and doc cleanup for Polynomial correction.
Refs #9574
Changeset: 466b26327be3f28b292cc83110c21a2d66de4448
comment:39 Changed 6 years ago by Martyn Gigg
Add usage examples for ConvertSpectrumAxis2
Refs #9574
Changeset: 1983a35110b3854e24b819747987934ba243206b
comment:41 Changed 6 years ago by Martyn Gigg
Number 12 onwards will be handled in #9627
comment:42 Changed 6 years ago by Martyn Gigg
Branch: feature/9574_doc_check_and_usage
Tester: Check each crossed-out page has usage examples and that everything generally looks okay with them
comment:43 Changed 6 years ago by Martyn Gigg
- Status changed from verify to reopened
- Resolution fixed deleted
comment:44 Changed 6 years ago by Martyn Gigg
- Status changed from reopened to inprogress
comment:45 Changed 6 years ago by Martyn Gigg
comment:46 Changed 6 years ago by Martyn Gigg
- Status changed from inprogress to verify
- Resolution set to fixed
comment:47 Changed 6 years ago by Peter Peterson
- Status changed from verify to verifying
- Tester set to Peter Peterson
comment:48 Changed 6 years ago by Peter Peterson
It appears that the ones not done here are in #9627.
comment:49 Changed 6 years ago by Pete Peterson
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9574_doc_check_and_usage'
Full changeset: 11cde05fd5f7314bb76e126765db06a906ece3ce
comment:50 Changed 6 years ago by Martyn Gigg
Update documentation & add usage for UpdateScriptRepository
Refs #9574
Changeset: 0110c83803fa730c9f82b97a5493eeed52103263
comment:51 Changed 6 years ago by Martyn Gigg
Implement usage for NormaliseByPeakArea
Also clarify a property description Refs #9574
Changeset: 23ec6429569b863ee2e71f8bf9f78fa195c8f55b
comment:52 Changed 6 years ago by Martyn Gigg
Remove unrequired testcleanup sections
Refs #9574
Changeset: aef06180361ba1c0cfcecafe0ec8de9135d149cc
comment:53 Changed 6 years ago by Martyn Gigg
Add hidden toctree to index.rst
This squashes all of the warnings about most documents not in a toctree. Refs #9574
Changeset: ab48ac0098251f55d4da3ed60bf3e0547d2e9f96
comment:54 Changed 6 years ago by Martyn Gigg
Add usage examples to DeleteWorkspace.
Refs #9574
Changeset: 38fe50272c2de9dc9797935df5982b9193c5abac
comment:55 Changed 6 years ago by Martyn Gigg
Add reference to t0 parameter in NormaliseByPeakArea.
Refs #9574
Changeset: 3b5290c2c9a69479cf35fc77e09780ad96bdd098
comment:56 Changed 6 years ago by Martyn Gigg
comment:57 Changed 6 years ago by Martyn Gigg
Update documentation of Mean and add a usage test.
Refs #9574
Changeset: 93442245565193ce1d9cd31fed345d56f5dfe609
comment:58 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10417