`pipestat_project_name` parameter to manager constructor is currently unused

databio / pypiper

Python toolkit for building restartable pipelines

http://pypiper.databio.org

BSD 2-Clause "Simplified" License

45 stars 9 forks source link

`pipestat_project_name` parameter to manager constructor is currently unused #213

Closed vreuter closed 4 months ago

vreuter commented 6 months ago

Is this a known issue? What's its intended use?

vreuter commented 6 months ago

I think it should be clarified by docstring if this is intended, for compatibility with some particular call-site use. Otherwise, I think this should be removed until it's used in the implementation.

donaldcampbelljr commented 6 months ago

Yeah, it appears as though it was left in there after a pipestat refactor. In pipestat we unified records to be record_Identifier instead of having either sample_name or project_name.

We should also rename pipestat_sample_name to pipestat_record_identifier for consistency: https://github.com/databio/pypiper/blob/3a8465a900f15a023afc2dd0b73e30cbf2e7eb24/pypiper/manager.py#L332-L334

donaldcampbelljr commented 6 months ago

Ok, this should be addressed now. I also noticed some of the values were missing from the doc strings so added them as well.