Ticket #8918 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Algorithm naming conventions/standards

Reported by: Nick Draper Owned by: Martyn Gigg
Priority: critical Milestone: Release 3.3
Component: Framework Keywords: SSC,2014,All
Cc: saviciat@… Blocked By:
Blocking: Tester: Owen Arnold

Description

Algorithm names are inconsistent. Define guidelines for how you come up with a name for an algorithm, e.g. use Create rather than Make/Generate for all, if for facility then use this

  • create a tool to identify algs that do not match standards

Change History

comment:1 Changed 7 years ago by Martyn Gigg

  • Owner set to Martyn Gigg

comment:2 Changed 7 years ago by Nick Draper

  • Status changed from new to assigned

Bulk move of tickets out of triage (new) to assigned at the introduction of the triage state

comment:3 Changed 6 years ago by Nick Draper

  • Milestone changed from Release 3.2 to Backlog

Moved to Backlog at the code freeze of release 3.2

comment:4 Changed 6 years ago by Nick Draper

  • Milestone changed from Backlog to Release 3.3

comment:5 Changed 6 years ago by Peter Peterson

  • Cc saviciat@… added

comment:6 Changed 6 years ago by Nick Draper

  • Priority changed from major to critical

Move all SSC tickets to critical by default

comment:7 Changed 6 years ago by Martyn Gigg

  • Status changed from assigned to inprogress

comment:8 Changed 6 years ago by Martyn Gigg

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

I have tidied up the Mantid Standards page and put in more guidelines, especially around algorithm naming. I don't think the list of prefixes is either exhaustive/complete but we can add things in the future.

Creation of the tool has been spun out to a separate issue, #10848, as it is lower priority.

There are no code changes for this issue.

comment:9 Changed 6 years ago by Owen Arnold

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

comment:10 Changed 6 years ago by Owen Arnold

  • Status changed from verifying to closed

comment:11 Changed 6 years ago by Nick Draper

  • Keywords SSC,2014,All added; SSC removed

comment:12 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 9761

Note: See TracTickets for help on using tickets.