Ticket #10035 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Endefrc needs documentation

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

Description

There is no documentation for this. People do not know how it works. See http://docs.mantidproject.org/nightly/fitfunctions/Gaussian.html for the sort of documentation we need.

Change History

comment:1 Changed 6 years ago by Karl Palmen

  • Cc anders.markvardsen@… added

This function was created for tube calibration. It is used to find the edge of a shadow of a wide object.

comment:2 Changed 6 years ago by Nick Draper

  • Status changed from new to assigned

comment:3 Changed 6 years ago by Karl Palmen

  • Status changed from assigned to inprogress

comment:4 Changed 6 years ago by Karl Palmen

Table of properties for EndErfc re #10035

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

Changeset: 932e39cafb530b7aef28a8b55d26a9bbf7469a33

comment:5 Changed 6 years ago by Karl Palmen

Basic description added re #10035

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

Changeset: fb4ab813dff4993559a713e189728bc8f62d1e46

comment:6 Changed 6 years ago by Karl Palmen

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

To test check that the documentation provides a basic description of the function and changes to the code do not require further testing.

Optionally you may run a MERLIN tube calibration script that worked for you before building the test version.

If more needs doing to the documentation, please give details including why it is essential. Nice to have features can be put into another ticket.

comment:7 Changed 6 years ago by Anders Markvardsen

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

comment:8 Changed 6 years ago by Karl Palmen

Remove historical line, which could confuse reader re #10035

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

Changeset: 3ef523563a7e21a81b7626ed59c0374582d66777

comment:9 Changed 6 years ago by Anders Markvardsen

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/10035_enderfc_doc'

Full changeset: 709aedd82e94dbe1e6be4fb10a9cad031f0d6d57

comment:10 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10877

Note: See TracTickets for help on using tickets.