CRPS for CDF API docstring
Closed this issue · 5 comments
When I was looking for another API entry, I happened to notice something in the CRPS for CDF API docstring in the development/latest branch (https://scores.readthedocs.io/en/latest/api.html#scores.probability.crps_cdf). Below is a screen shot of the sentences I happened to notice:
I am confused by what these sentences mean. In particular, is the sentence "When include_components=True." meant to be there, and if so, is it meant to be part of either the preceding or following sentence?
I think the mistake here is the full stop after "True", that can be removed. The nature of the decomposition in crps_for_cdf is different to the nature of the decomposition in crps_for_ensemble, so the intention is to convey that people shouldn't assume it's the same thing even though they are both valid in context.
Since the decomposition is optional, the caveat only applies when include_components is set to True in the optional argument.
Also, the source code has :py:func:scores.probability.crps_for_ensemble decomposition - in the docs this doesn't form a clickable link. I think the backtick might need to go after the word ensemble and before the word decomposition.
I think that " include_components=True." should have double back ticks around it.
And yes, I agree with @tennlee that the full stop should be removed.