Ticket #9919 (closed: duplicate)

Opened 6 years ago

Last modified 5 years ago

Add missing Algorithm Usage examples

Reported by: Nick Draper Owned by: Ricardo Leal
Priority: major Milestone: Release 3.3
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: #7517 Tester: Harry Jeffery

Description (last modified by Nick Draper) (diff)

The following algorithms were found to be missing usage examples or have no rst file at all.

The outstanding documentation tickets were checked, but a match could not be found, so these appear to be missed.

  1. SetupILLD33Reduction
  2. LoadILL
  3. LoadILLSANS
  4. LoadILLIndirect
  5. LoadILLReflectometry
  6. LoadILLAscii
  7. LoadLLB

Please add a usage example wherever possible

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Owner changed from Nick Draper to Ricardo Leal
  • Status changed from new to assigned
  • Description modified (diff)
  • Summary changed from Add missing Algorithm Usage examples (cloned) to Add missing Algorithm Usage examples

comment:2 Changed 6 years ago by Ricardo Ferraz Leal

  • Status changed from assigned to inprogress

Re #9919 New doc for LoadILL

Changeset: 001206defe5f61ba22116d900e6838bd94a74575

comment:3 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 New doc for LoadILLAscii

Changeset: c078ba81f75695ba8f45b48f8e5c0402f61de698

comment:4 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 New doc for LoadLLB

Changeset: bb61bf4145642780fb37bcccaeffbc5924a98388

comment:5 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 New doc for LoadILLIndirect

Changeset: 5d035410ece8c374ba1f3d8edf53f54772b1d3b2

comment:6 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 New doc for Load ILL SANS

Changeset: 190688f06097b56b058a4d9db35174b18b585f54

comment:7 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 New doc for Load ILL SANS

Changeset: a2f4fd7f906c2ad8847623b1e25072eb77277bcb

comment:8 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 New doc for Setup ILL SANS Reduction

Changeset: c4cdb935fab2ad2224060b2c2c364809ea262ba9

comment:9 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 New doc for ILL Reflectometry

Changeset: c5509dcea0c2f866f6d1fdb2c3cf4030bc24f531

comment:10 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for ILL Reflectometry"

This reverts commit c5509dcea0c2f866f6d1fdb2c3cf4030bc24f531.

Changeset: 6345d88ec8ff7f714517ae677eaf1768e3e7eb66

comment:11 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for Setup ILL SANS Reduction"

This reverts commit c4cdb935fab2ad2224060b2c2c364809ea262ba9.

Changeset: 20e9d336b7c68275a61692b875750d437dcbda53

comment:12 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for Load ILL SANS"

This reverts commit a2f4fd7f906c2ad8847623b1e25072eb77277bcb.

Changeset: b6d74797bda380940dbe8e48a93116d16cc5288a

comment:13 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for Load ILL SANS"

This reverts commit 190688f06097b56b058a4d9db35174b18b585f54.

Changeset: 250d3a4e1c6b903d7eecb2c897a8d067bd042fc0

comment:14 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for LoadILLIndirect"

This reverts commit 5d035410ece8c374ba1f3d8edf53f54772b1d3b2.

Changeset: 09fa0abc64d58b0988299ce69bf33a598f02ec62

comment:15 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for LoadLLB"

This reverts commit bb61bf4145642780fb37bcccaeffbc5924a98388.

Changeset: 574c8de639941ec378b5ac333e0279745ffdf7e4

comment:16 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for LoadILLAscii"

This reverts commit c078ba81f75695ba8f45b48f8e5c0402f61de698.

Changeset: c850fdac4e40b224750b4af7927f86500245da20

comment:17 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for LoadILL"

This reverts commit 001206defe5f61ba22116d900e6838bd94a74575.

Changeset: dfcd70c2ca31586750909a3ba9e1d94c97285cf8

comment:18 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Added existing files to the Test

Changeset: 6ff069d9feb4d756a6868475ac8ce77a4cb5e66a

comment:19 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Fix merge with develop

Changeset: c63637efefb0f104747fdf59c13bf0f6f70c1f20

comment:20 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Added real D2B ascii file to the Test

Changeset: f246c37473c71f0edf9cbc067e38e5e96042af54

comment:21 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Fix merge with develop

Changeset: 7bcc667d1ce333fa5af2548d3a05408a604a03ac

comment:22 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Added real data to the usage doc.

Changeset: 35217f564a680bab77b63fdd2995dfa6ceb51049

comment:23 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Fix merge with develop

Changeset: 57670bb583258e74c55a275f5cf55453908c2058

comment:24 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Moved real data to the usage folder.

Changeset: 798c84b79c6ebbdd1fac3c291e3e8b64c20489bc

comment:25 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Fix merge with develop

Changeset: 5bb5a950f261c2fcbeca5d4638482ee3fcd40a6d

comment:26 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Moved D17 data to the usage folder.

Changeset: 458b516aba96311165cb243aa737329e5f1e1eea

comment:27 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Fix merge with develop

Changeset: 6d2891cabd7d430423dbe752bdc96e8c1f2e0867

comment:28 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Fix non ascii character

Changeset: 545a68dcd7c72bdfc0b5bdc68e11fc81de793ca1

comment:29 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Usage code with non executable python code.

Changeset: 9d641021444d8e1f85f173d74536b0794477892b

comment:30 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Usage code with non executable python code.

Changeset: c9ba26f9726af4541562c2334a11539706c20c1f

comment:31 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Fix Merge with develop

Changeset: 51deacc4a13b65f3008954c6987edb6e9e1e2e31

comment:32 Changed 6 years ago by Ricardo Leal

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

Ended up using only code-block. The usage code is not interpreted. There are system tests making sure the code is valid.

comment:33 Changed 6 years ago by Owen Arnold

  • Status changed from verify to verifying
  • Tester set to Owen Arnold

comment:34 Changed 6 years ago by Owen Arnold

I've checked all usage example and they look fine, but I cant find this branch in the repository. Can you make sure that you have published both branches to the mantid and systemtest repositories.

comment:35 Changed 6 years ago by Owen Arnold

  • Status changed from verifying to reopened
  • Resolution fixed deleted

Branch is still missing from public mantid repository

comment:36 Changed 6 years ago by Nick Draper

  • Blocking 7517 added

comment:37 Changed 6 years ago by Ricardo Ferraz Leal

  • Status changed from reopened to inprogress

Re #9919 New doc for LoadILL

Changeset: 001206defe5f61ba22116d900e6838bd94a74575

comment:38 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 New doc for LoadILLAscii

Changeset: c078ba81f75695ba8f45b48f8e5c0402f61de698

comment:39 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 New doc for LoadLLB

Changeset: bb61bf4145642780fb37bcccaeffbc5924a98388

comment:40 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 New doc for LoadILLIndirect

Changeset: 5d035410ece8c374ba1f3d8edf53f54772b1d3b2

comment:41 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 New doc for Load ILL SANS

Changeset: 190688f06097b56b058a4d9db35174b18b585f54

comment:42 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 New doc for Load ILL SANS

Changeset: a2f4fd7f906c2ad8847623b1e25072eb77277bcb

comment:43 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 New doc for Setup ILL SANS Reduction

Changeset: c4cdb935fab2ad2224060b2c2c364809ea262ba9

comment:44 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 New doc for ILL Reflectometry

Changeset: c5509dcea0c2f866f6d1fdb2c3cf4030bc24f531

comment:45 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for ILL Reflectometry"

This reverts commit c5509dcea0c2f866f6d1fdb2c3cf4030bc24f531.

Changeset: 6345d88ec8ff7f714517ae677eaf1768e3e7eb66

comment:46 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for Setup ILL SANS Reduction"

This reverts commit c4cdb935fab2ad2224060b2c2c364809ea262ba9.

Changeset: 20e9d336b7c68275a61692b875750d437dcbda53

comment:47 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for Load ILL SANS"

This reverts commit a2f4fd7f906c2ad8847623b1e25072eb77277bcb.

Changeset: b6d74797bda380940dbe8e48a93116d16cc5288a

comment:48 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for Load ILL SANS"

This reverts commit 190688f06097b56b058a4d9db35174b18b585f54.

Changeset: 250d3a4e1c6b903d7eecb2c897a8d067bd042fc0

comment:49 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for LoadILLIndirect"

This reverts commit 5d035410ece8c374ba1f3d8edf53f54772b1d3b2.

Changeset: 09fa0abc64d58b0988299ce69bf33a598f02ec62

comment:50 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for LoadLLB"

This reverts commit bb61bf4145642780fb37bcccaeffbc5924a98388.

Changeset: 574c8de639941ec378b5ac333e0279745ffdf7e4

comment:51 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for LoadILLAscii"

This reverts commit c078ba81f75695ba8f45b48f8e5c0402f61de698.

Changeset: c850fdac4e40b224750b4af7927f86500245da20

comment:52 Changed 6 years ago by Ricardo Ferraz Leal

Revert "Re #9919 New doc for LoadILL"

This reverts commit 001206defe5f61ba22116d900e6838bd94a74575.

Changeset: dfcd70c2ca31586750909a3ba9e1d94c97285cf8

comment:53 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Added existing files to the Test

Changeset: 6ff069d9feb4d756a6868475ac8ce77a4cb5e66a

comment:54 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Fix merge with develop

Changeset: c63637efefb0f104747fdf59c13bf0f6f70c1f20

comment:55 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Added real D2B ascii file to the Test

Changeset: f246c37473c71f0edf9cbc067e38e5e96042af54

comment:56 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Fix merge with develop

Changeset: 7bcc667d1ce333fa5af2548d3a05408a604a03ac

comment:57 Changed 6 years ago by Ricardo Ferraz Leal

Re #9919 Fix Merge with develop

Changeset: 51deacc4a13b65f3008954c6987edb6e9e1e2e31

comment:58 Changed 6 years ago by Ricardo Leal

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

My fault, the system tests were already there (see ticket: #9903). Also it looks like these changes were already merged in the ticket #9713. To test I have just merged this branch with the master and git diff master returns nothing... I guess this ticket can be closed / canceled...

Last edited 6 years ago by Ricardo Leal (previous) (diff)

comment:59 Changed 6 years ago by Harry Jeffery

  • Status changed from verify to verifying
  • Tester changed from Owen Arnold to Harry Jeffery

comment:60 Changed 6 years ago by Harry Jeffery

  • Status changed from verifying to closed

All algorithms listed have a usage example in master.

comment:61 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10761

Note: See TracTickets for help on using tickets.