Ticket #9577 (closed: fixed)
Check Documentation
Reported by: | Nick Draper | Owned by: | Stuart Campbell |
---|---|---|---|
Priority: | critical | Milestone: | Release 3.2 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Tester: | Peter Peterson |
Description (last modified by Stuart Campbell) (diff)
Please check the documentation for these algorithms (check images, formatting etc). 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
- CuboidGaugeVolumeAbsorption.cpp
- CreateFlatEventWorkspace.cpp
- RecordPythonScript.cpp
- AddLogDerivative.cpp
- SignalOverError.cpp
- FilterByLogValue.cpp
- HRPDSlabCanAbsorption.cpp
- GetEi2.cpp
- SolidAngle.cpp
- DetectorDiagnostic.cpp
- ExponentialMD.cpp
- LogarithmMD.cpp
- MergeMDFiles.cpp
- PowerMD.cpp
- BinMD.cpp
- ConvertToDetectorFaceMD.cpp
- MaskMD.cpp
- CombinePeaksWorkspaces.cpp
- DiffPeaksWorkspaces.cpp
- FilterPeaks.cpp
- EQSANSAzimuthalAverage1D.py
- EQSANSDirectBeamTransmission.py
- EQSANSNormalise.py
- CreateChopperModel.cpp
- CreateModeratorModel.cpp
- CreateSimulationWorkspace.cpp
- ReplaceSpecialValues.cpp
- StripVanadiumPeaks2.cpp
- TOFSANSResolution.cpp
- CompressEvents.cpp
- LoadParameterFile.cpp
- LoadSpec.cpp
- SaveMask.cpp
Change History
comment:1 Changed 6 years ago by Nick Draper
- Status changed from new to assigned
- Owner changed from Owen Arnold to Stuart Campbell
- Description modified (diff)
- Summary changed from Check Documentation and add algorithm usage examples (cloned) to Check Documentation and add algorithm usage examples
comment:2 Changed 6 years ago by Stuart Campbell
- Description modified (diff)
- Summary changed from Check Documentation and add algorithm usage examples to Check Documentation
comment:5 Changed 6 years ago by Stuart Campbell
Checked docs. refs #9577
Changeset: fb45d0364c77aa2b21f1f0ca77b2cab8a10203a1
comment:6 Changed 6 years ago by Stuart Campbell
Checked docs. refs #9577
Changeset: 0db2d79c7c6c6c26b2bf0b734713d7b43e359b73
comment:7 Changed 6 years ago by Stuart Campbell
Checked docs. refs #9577
Changeset: fb7c7089781547263384a78cb38adc639a087166
comment:8 Changed 6 years ago by Stuart Campbell
Checked docs. refs #9577
Changeset: 4a65629f51335db070cb002ce760ae5ff0e2563e
comment:9 Changed 6 years ago by Stuart Campbell
Checked docs. refs #9577
Changeset: 20d67085b3e7fcbcebb1d46dd2dce6eb59e58e1f
comment:10 Changed 6 years ago by Stuart Campbell
Checked docs. refs #9577
Changeset: 873df169cca3a5222d3474746acc5e29553f3c5f
comment:11 Changed 6 years ago by Stuart Campbell
Added image to GetEi v2. refs #9577
Changeset: da378d148a6c43139031ab75c5bb6d3c4c655464
comment:12 Changed 6 years ago by Stuart Campbell
Added links to algorithms. refs #9577
Changeset: d3a4fd2ff0fdda1c3e9bb6579d984fffe7e67b83
comment:13 Changed 6 years ago by Stuart Campbell
Updated links to static pages. refs #9577
Changeset: 83a43705c9a53ccf244d59200aec7e996f8c5921
comment:14 Changed 6 years ago by Stuart Campbell
Updated links to static pages. refs #9577
Changeset: 208575531d52ac9a60826de02b68b5efb98ffb09
comment:15 Changed 6 years ago by Stuart Campbell
Added link to MDHistoWorkspace. refs #9577
Changeset: ae3802af972b4abbb4bee104a0acc3d8db8dd799
comment:16 Changed 6 years ago by Stuart Campbell
Updated links to static pages for workspace types. refs #9577
Changeset: c36bb763e4215cfa93beb2366a7e4f1163f93bfd
comment:17 Changed 6 years ago by Stuart Campbell
Updated static links. refs #9577
Changeset: a292580481062f17139fea750480bee4269f823b
comment:18 Changed 6 years ago by Stuart Campbell
Updated links and resized image. refs #9577
Changeset: de81fa2620f1211d1521a59942413c33a99fc9b3
comment:19 Changed 6 years ago by Stuart Campbell
Updated static links, corrected spelling. refs #9577
Changeset: 6e3bd14e1a651905a422244096141d74ec44d0ec
comment:20 Changed 6 years ago by Stuart Campbell
Added static link. refs #9577
Changeset: c0dfe617f16f883fa7684e5e4d1a7bcc2e919823
comment:21 Changed 6 years ago by Stuart Campbell
Updated static links. refs #9577
Changeset: 5f7da99d35a44e900362b683e1e040cba6ce5ff4
comment:22 Changed 6 years ago by Stuart Campbell
Added some static links and replaced missing text.
refs #9577
Changeset: d7060a776af0414644d03503827eb1c03cf09e82
comment:23 Changed 6 years ago by Stuart Campbell
Added static links. refs #9577
Changeset: 853be3ddbf81b801f2eb6455c64c654439e91b87
comment:24 Changed 6 years ago by Stuart Campbell
Corrected problems in docs. refs #9577
Added xml code-block back. Corrected mask text.
Changeset: 8c9efe2e0665331df1d695f4931c3f428b488ec3
comment:25 Changed 6 years ago by Stuart Campbell
- Status changed from inprogress to verify
- Resolution set to fixed
comment:26 Changed 6 years ago by Peter Peterson
- Status changed from verify to verifying
- Tester set to Peter Peterson
comment:27 Changed 6 years ago by Pete Peterson
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9577_check_docs'
Full changeset: ba4c6b1ab7c8f5b48be70a1ce799a1ae963048af
comment:28 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10420