pypiper icon indicating copy to clipboard operation
pypiper copied to clipboard

Published 20 hours ago • verified publisher icon databio

report_result docstrings for value is inaccurate

Open donaldcampbelljr opened this issue 1 year ago • 2 comments

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

donaldcampbelljr avatar Feb 13 '24 19:02 donaldcampbelljr

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

nsheff avatar Feb 13 '24 20:02 nsheff

the docstrings need to be updated: image

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.

donaldcampbelljr avatar Feb 14 '24 15:02 donaldcampbelljr