Ticket #10875 (closed: fixed)
IntegrateEllipsoids Better Docs
Reported by: | Owen Arnold | Owned by: | Owen Arnold |
---|---|---|---|
Priority: | minor | Milestone: | Release 3.4 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | #10878 | Tester: | Pete Peterson |
Description
Looking through the code for IntegrateEllipsoids, I think that the documentation is in general good, but is slightly lacking in some key areas. The fact that calculated results are pass-by-ref, already makes this quite tricky to read, so some additional documentation may help here.
Change History
comment:2 Changed 6 years ago by Owen Arnold
- Status changed from assigned to inprogress
refs #10875. Better docs.
Changed algorithm documentation as well as documentation in the source code.
Changeset: ad2c3d421a4fdae7857db665509f6e4da395331e
comment:4 Changed 6 years ago by Owen Arnold
- Status changed from inprogress to verify
- Resolution set to fixed
This is being verified as pull request #248.
comment:5 Changed 6 years ago by Owen Arnold
Tester. Read the documentation. It should make it clearer what the algorithm is doing.
comment:6 Changed 6 years ago by Pete Peterson
- Status changed from verify to verifying
- Tester set to Pete Peterson
comment:7 Changed 6 years ago by Pete Peterson
- Status changed from verifying to closed
Merge pull request #248 from mantidproject/feature/10875_integrate_ellipsoids_docs
IntegrateEllipsoids Better Documentation
Full changeset: 362855459b521741987362214cef3c4b2d79b53e