Ticket #9586 (assigned)

Opened 6 years ago

Last modified 5 years ago

Check Documentation and add algorithm usage examples

Reported by: Nick Draper Owned by: Ross Miller
Priority: critical Milestone: Release 3.5
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: Tester:

Description (last modified by Nick Draper) (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, DiffractionFocussing 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. AbortRemoteJob.cpp
  2. Authenticate.cpp
  3. DownloadRemoteFile.cpp
  4. QueryAllRemoteJobs.cpp
  5. QueryRemoteFile.cpp
  6. QueryRemoteJob.cpp
  7. StartRemoteTransaction.cpp
  8. StopRemoteTransaction.cpp
  9. SubmitRemoteJob.cpp
  10. UploadRemoteFile.cpp

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Owner changed from Jay Rainey to Ross Miller
  • 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:2 Changed 6 years ago by Nick Draper

  • Milestone changed from Release 3.2 to Release 3.3

comment:3 Changed 6 years ago by Nick Draper

  • Milestone changed from Release 3.3 to Release 3.4

Moved at the end of R3.3

comment:4 Changed 5 years ago by Nick Draper

  • Milestone changed from Release 3.4 to Release 3.5

Moved to R3.5 at the end of R3.4

comment:5 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10429

Note: See TracTickets for help on using tickets.