databio / pypiper

Python toolkit for building restartable pipelines
http://pypiper.databio.org
BSD 2-Clause "Simplified" License
45 stars 9 forks source link

Documentation of the key method to implement to create a Pipeline type is wrong #191

Open vreuter opened 1 year ago

vreuter commented 1 year ago

Pipeline.stages suggests a collection of names, rather than callables, Stage instances, or the like.

https://github.com/databio/pypiper/blob/master/pypiper/pipeline.py#L175-L179

vreuter commented 1 year ago

It seems to need to be a collection of pairs of name and callable, or name and Stage (or a mapping from name to callable or stage): https://github.com/databio/pypiper/blob/master/pypiper/pipeline.py#L115-L122