Ticket #9274 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Improve Workflow Algorithm Documentation and Testing

Reported by: Nick Draper Owned by: Nick Draper
Priority: critical Milestone: Release 3.4
Component: Documentation Keywords: SSC,2014,All
Cc: Blocked By: #8917
Blocking: Tester: Martyn Gigg

Description (last modified by Nick Draper) (diff)

Documentation for these should include a workflow diagram. "We need some improved checking tools for python, this may already be done under #8917

-- TO BE AGREED BY ALL AFTER THOUGHT--

  1. Future workflow algs should be Python algs unless there is a reason to do otherwise.
  2. Some existing may require porting if Nested history and improved documentation is not sufficient " NOT NEEDED.
  3. Implement a python static code analysis tool Pylint Done
  4. using dot for flowcharts in the future - another ticket

Change History

comment:1 Changed 6 years ago by Peter Peterson

  • Description modified (diff)

comment:2 Changed 6 years ago by Peter Peterson

  • Description modified (diff)

comment:3 Changed 6 years ago by Nick Draper

  • Milestone changed from Release 3.3 to Release 3.4

comment:4 Changed 6 years ago by Nick Draper

  • Priority changed from major to critical

Move all SSC tickets to critical by default

comment:5 Changed 6 years ago by Owen Arnold

  • Status changed from new to assigned

I agree with the better documentation and flow diagrams. I do not agree that all workflow (dataprocessing algorithms) should be in python. The nested workspace history introduced in 2014 mitigates this requirement.

comment:6 Changed 6 years ago by Nick Draper

  • Keywords SSC,2014,All added; SSC removed

comment:7 Changed 6 years ago by Nick Draper

  • Owner set to Nick Draper
  • Description modified (diff)

comment:8 Changed 6 years ago by Nick Draper

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

All of the aspects of this that need doing are I beleive done, the SSC 20215 were happy with the current situation and level of workflow documentation and Nested history support.

comment:9 Changed 6 years ago by Nick Draper

Batch modify all SSC tickets to critical priority (this will also show up as an update for all those already as critical)

comment:10 Changed 6 years ago by Martyn Gigg

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

comment:11 Changed 6 years ago by Martyn Gigg

  • Status changed from verifying to closed

comment:12 Changed 5 years ago by Nick Draper

  • Component changed from Framework to Documentation

comment:13 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10117

Note: See TracTickets for help on using tickets.