Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

report_result docstrings for value is inaccurate #204

Open
donaldcampbelljr opened this issue Feb 13, 2024 · 2 comments
Open

report_result docstrings for value is inaccurate #204

donaldcampbelljr opened this issue Feb 13, 2024 · 2 comments

Comments

@donaldcampbelljr
Copy link
Member

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
Copy link
Member

nsheff commented Feb 13, 2024

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

@donaldcampbelljr
Copy link
Member Author

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 donaldcampbelljr changed the title report_result type hint for value is inaccurate report_result docstrings for value is inaccurate Feb 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nsheff @donaldcampbelljr