Ticket #9997 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Correct the documentation of LoadInstrumentFromNexus

Reported by: Karl Palmen Owned by: Karl Palmen
Priority: major Milestone: Release 3.3
Component: Framework Keywords:
Cc: anders.markvardsen@… Blocked By:
Blocking: Tester: Anders Markvardsen

Description

The documentation does not reflect the reality of the algorithm and the usage example is misleading. Correct both to reflect reality. Also remove the reference to it being used by LoadMuonNexus, because ticket #9996 will remove this usage.

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Status changed from new to assigned

comment:2 Changed 6 years ago by Karl Palmen

  • Status changed from assigned to inprogress

comment:3 Changed 6 years ago by Karl Palmen

Revise documentation including usage example re #9997

It was also necessary to initialize a variable within the algorithm for the usage example to work correctly.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 02ba7ac90a174b44e4aaf3e71bc1752c6204f19e

comment:4 Changed 6 years ago by Karl Palmen

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

To test, check that the changes to documentation are satisfactory and the algorithm works as well as it did before.

comment:5 Changed 6 years ago by Anders Markvardsen

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

comment:6 Changed 6 years ago by Anders Markvardsen

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9997_doc_correct_lifn'

Full changeset: ​48438eebffb5ed10f30e0401230fdde7f72efa3b

comment:7 Changed 6 years ago by Anders Markvardsen

tested updated usage example

comment:8 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​10839

Note: See TracTickets for help on using tickets.