report_result docstrings for value is inaccurate

databio / pypiper

Python toolkit for building restartable pipelines

http://pypiper.databio.org

BSD 2-Clause "Simplified" License

45 stars 9 forks source link

report_result docstrings for value is inaccurate #204

Open donaldcampbelljr opened 6 months ago

donaldcampbelljr commented 6 months ago

I am experiencing this as I use pypiper in Bedbase.

pm.report_result(key="bedtype", value=self.bed_type)

It expects value to be a dict, but it does not need to be a dict. It could be a dict or a primitive.

Pypiper version v0.14.0

nsheff commented 6 months ago

I don't understand the problem, sorry. Can you clarify?

donaldcampbelljr commented 6 months ago

the docstrings need to be updated:

Value can be a dict OR it can be a string/integer etc. Because the function goes on to great a dict = {key:value} which it passes to pipestat.report.