Ticket #6476 (closed: fixed)
Important Documentation
| Reported by: | Owen Arnold | Owned by: | Dennis Mikkelson |
|---|---|---|---|
| Priority: | critical | Milestone: | Release 2.4 |
| Component: | Mantid | Keywords: | |
| Cc: | Blocked By: | #6331 | |
| Blocking: | Tester: | Owen Arnold |
Description
We have a very nice new algorithm IntegrateEllipsoids, but the lack of documentation is really going to annoy the users.
As this algorithm is at least as complex as IntegratePeaksMD, we ought to have the same (or better) level of documentaion. See this http://www.mantidproject.org/IntegratePeaksMD. Ideally this documentation should be in place before we announce the release.
Change History
comment:2 Changed 8 years ago by Dennis Mikkelson
RE 6476 Improve documentation for IntegrateEllipsoids
Added introductory "Overview" section. Added "Explanation of Inputs" section with diagram. The original documentation is now in a section titled "Detailed Algorithm Description". The equations for background subtraction are the same as for the IntegratePeaksMD, so the user is referred to the documentation for that algorithm, rather than cutting and pasting that part of the docs to this algorithm.
refs #6476
Changeset: a39576b53dd85492dfb719e8950d00df2d9eec8b
comment:3 Changed 8 years ago by Dennis Mikkelson
RE 6476 Improve documentation for IntegrateEllipsoids
One "final" edit.
refs #6476
Changeset: e720c6987a36154382e32742e4cf4ee41eedfe0e
comment:5 Changed 8 years ago by Dennis Mikkelson
- Status changed from accepted to verify
- Resolution set to fixed
comment:6 Changed 8 years ago by Owen Arnold
- Status changed from verify to verifying
- Tester set to Owen Arnold
comment:7 Changed 8 years ago by Owen Arnold
- Status changed from verifying to closed
Documentation looks excellent.
comment:8 Changed 8 years ago by Dennis Mikkelson
RE 6476 Improve documentation for IntegrateEllipsoids
Added introductory "Overview" section. Added "Explanation of Inputs" section with diagram. The original documentation is now in a section titled "Detailed Algorithm Description". The equations for background subtraction are the same as for the IntegratePeaksMD, so the user is referred to the documentation for that algorithm, rather than cutting and pasting that part of the docs to this algorithm.
refs #6476
Changeset: a39576b53dd85492dfb719e8950d00df2d9eec8b
comment:9 Changed 8 years ago by Dennis Mikkelson
RE 6476 Improve documentation for IntegrateEllipsoids
One "final" edit.
refs #6476
Changeset: e720c6987a36154382e32742e4cf4ee41eedfe0e
comment:10 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 7322
