Ticket #9607 (assigned)

Opened 6 years ago

Last modified 5 years ago

Check Documentation and add algorithm usage examples (cloned)

Reported by: Nick Draper Owned by: Owen Arnold
Priority: critical Milestone: Backlog
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: Tester:

Description (last modified by Jay Rainey) (diff)

Cloned from #9576:

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

  1. SpecularReflectionCalculateTheta.cpp
  1. CalculateUMatrix.cpp
  2. CentroidPeaks.cpp
  3. FindClusterFaces.cpp
  4. IntegratePeaksUsingClusters.cpp
  5. SetSpecialCoordinates.cpp
  6. SortXAxis.py
  7. AndMD.cpp
  8. CloneMDWorkspace.cpp
  9. CreateMDWorkspace.cpp
  10. DivideMD.cpp
  11. EqualToMD.cpp
  12. LessThanMD.cpp
  13. MinusMD.cpp
  14. MultiplyMD.cpp
  15. NotMD.cpp
  16. OrMD.cpp
  17. PlusMD.cpp
  18. SetMDUsingMask.cpp
  19. TransformMD.cpp
  20. WeightedMeanMD.cpp
  21. XorMD.cpp
  22. GreaterThanMD.cpp
  23. SetSpecialCoordinates.cpp

Change History

comment:1 Changed 6 years ago by Owen Arnold

  • Description modified (diff)

comment:2 Changed 6 years ago by Nick Draper

  • Status changed from new to assigned

comment:3 Changed 6 years ago by Jay Rainey

  • Description modified (diff)

comment:4 Changed 6 years ago by Owen Arnold

  • Milestone changed from Release 3.2 to Release 3.3

No time to get this into the 3.2 release

comment:5 Changed 6 years ago by Owen Arnold

  • Milestone changed from Release 3.3 to Backlog

comment:6 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10450

Note: See TracTickets for help on using tickets.