Ticket #9612 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Add algorithm usage examples lot 1

Reported by: Nick Draper Owned by: Nick Draper
Priority: critical Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: Tester: Martyn Gigg

Description (last modified by Nick Draper) (diff)

Cloned from #9577:

Please 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. CuboidGaugeVolumeAbsorption.cpp
  2. CreateFlatEventWorkspace.cpp
  3. RecordPythonScript.cpp
  4. AddLogDerivative.cpp
  5. SignalOverError.cpp
  6. FilterByLogValue.cpp
  7. HRPDSlabCanAbsorption.cpp
  8. GetEi2.cpp
  9. SolidAngle.cpp
  10. ReplaceSpecialValues.cpp
  11. StripVanadiumPeaks2.cpp - already done by me in another ticket
  12. CompressEvents.cpp

Change History

comment:1 Changed 6 years ago by Stuart Campbell

  • type changed from enhancement to task
  • Description modified (diff)
  • Summary changed from Check Documentation and add algorithm usage examples (cloned) to Add algorithm usage examples

comment:2 Changed 6 years ago by Nick Draper

  • Status changed from new to assigned

comment:3 Changed 6 years ago by Nick Draper

branch created: feature/9612_SC_doc_usage

comment:4 Changed 6 years ago by Nick Draper

  • Status changed from assigned to inprogress

re #9612 done 1-9 inclusive

Changeset: 898b9ded7c7ecfb96fe1aa7bd56498a46952d7c0

comment:5 Changed 6 years ago by Nick Draper

  • Description modified (diff)

comment:6 Changed 6 years ago by Nick Draper

  • Description modified (diff)
  • Summary changed from Add algorithm usage examples to Add algorithm usage examples lot 1

comment:7 Changed 6 years ago by Nick Draper

re #9612 done all of them, although some were put into another ticket

Changeset: b97e3a1671ccb5f0d4d53d6f640bf4eebec05a0c

comment:8 Changed 6 years ago by Nick Draper

re #9612 replace non ascii characters

Changeset: 19ed3056d782db216c389ff884c900c079deda4a

comment:9 Changed 6 years ago by Nick Draper

re #9612 result indentation

Changeset: dc50c865cf2730d079ad224dfda582cb4cc24f51

comment:10 Changed 6 years ago by Nick Draper

To test:

  1. Check that the doctests pass
  2. check the pages seem reasonable

comment:11 Changed 6 years ago by Nick Draper

  • Status changed from inprogress to verify
  • Owner changed from Stuart Campbell to Nick Draper
  • Resolution set to fixed

comment:12 Changed 6 years ago by Anders Markvardsen

  • Status changed from verify to verifying
  • Tester set to Anders Markvardsen

comment:13 Changed 6 years ago by Martyn Gigg

  • Status changed from verifying to verify
  • Tester Anders Markvardsen deleted

comment:14 Changed 6 years ago by Martyn Gigg

  • Status changed from verify to verifying
  • Tester set to Martyn Gigg

comment:15 Changed 6 years ago by Martyn Gigg

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9612_SC_doc_usage'

Full changeset: ​16917ab7b8f21602d5e380fdd4c0b644853e24e0

comment:16 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10455

Note: See TracTickets for help on using tickets.