Ticket #9570 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Check Documentation and add algorithm usage examples

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

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 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. Divide.cpp
  2. Minus.cpp
  3. Multiply.cpp
  4. Plus.cpp
  5. PoissonErrors.cpp
  6. WeightedMean.cpp
  7. SaveReflTBL.cpp
  8. SaveSPE.cpp
  9. SaveANSTOAscii.cpp
  10. SaveAscii2.cpp
  11. SaveILLCosmosAscii.cpp
  12. LoadLog.cpp

Attachments

Multiply.html.png (166.3 KB) - added by Martyn Gigg 6 years ago.

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Status changed from new to assigned
  • Owner changed from Arturs Bekasovs to Keith Brown
  • Description modified (diff)

comment:2 Changed 6 years ago by Nick Draper

  • Summary changed from Check Documentation and add algorithm usage examples (cloned) (cloned) to Check Documentation and add algorithm usage examples

comment:3 Changed 6 years ago by Keith Brown

  • Status changed from assigned to inprogress

Refs #9570 5 out of 12 complete

SaveANSTOAscii, SaveReflTBL, SaveILLCosmosAscii, WeightedMean and PoissonErrors have been checked and usage examples added.

Changeset: 4a3a6549fd3076ba4eb26dd90374c1db239bc732

comment:4 Changed 6 years ago by Keith Brown

Refs #9570 Added example headings

Examples now have headings

Changeset: f85771c9dc2a013a966eb5683a0f6f58c9e460e3

comment:5 Changed 6 years ago by Keith Brown

Refs #9570 Added SPE format

The SPE page now has details on its format

Changeset: d513d17c6d800036b092aad82ec550066416939c

comment:6 Changed 6 years ago by Keith Brown

Refs #9570 Changed fixed width formatting

LoadLog now has a usage example

Most text which needs to be fixed width is now in code blocks. Those remaining using the double backtick () style are supposed to be like that as they're supposed to be inline

Changeset: 272a8f93dd1dab0e5f9f55251760015101c5505e

comment:7 Changed 6 years ago by Keith Brown

Refs #9570 SaveAsciiv2 now has usage examples

SaveAsciiv2 has three usage examples. The algorithm file itself got an edit to make a property description better.

Various formatting tidy-up

Changeset: 6470c5b46eac87b459210b8dd83aee43afa83154

comment:8 Changed 6 years ago by Keith Brown

Refs #9570 Binary Opperation algorithms done

Plus, Minus, Divide and Multiply posed a problem as they all used a template. This has been ported across and they've each had usage examples added.

Fixed a problem with the SaveAscii Doctest

Changeset: d28d587a57917e8b0d907d6a51f9f52d64526a71

comment:9 Changed 6 years ago by Keith Brown

Refs #9570 Wrong file added, fixing usage test

Fixing usage example by adding the right file this time. Removing the wrong file.

Changeset: b50c69875966b79d62a6d56a1e783093b5e63330

comment:10 Changed 6 years ago by Keith Brown

  • Status changed from inprogress to verify
  • Resolution set to fixed

comment:11 Changed 6 years ago by Martyn Gigg

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

comment:12 Changed 6 years ago by Martyn Gigg

  • Status changed from verifying to reopened
  • Resolution fixed deleted

They all look okay apart from the BinaryOperation ones. I've attached a screenshot of the built html. It looks like a replacement of |symbol| hasn't happened properly.

Changed 6 years ago by Martyn Gigg

comment:13 Changed 6 years ago by Keith Brown

  • Status changed from reopened to inprogress

Refs #9570 fixed susbstitution

a susbstitution didn't work due to a typo, fixed

Changeset: cfd209464ab7b4d01531960dab87595d9ab7abe1

comment:14 Changed 6 years ago by Keith Brown

  • Status changed from inprogress to verify
  • Resolution set to fixed

comment:15 Changed 6 years ago by Martyn Gigg

  • Status changed from verify to verifying

comment:16 Changed 6 years ago by Martyn Gigg

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9570_Check_docs_and_usage_examples'

Full changeset: 3eb4fdd5df5c1633f5d1607e2d140668a4606400

comment:17 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10413

Note: See TracTickets for help on using tickets.