-
Notifications
You must be signed in to change notification settings - Fork 27
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.
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
Brier Score - References in API & Tutorial #619
Comments
(1) The wikipedia entry is much more accessible to quickly get across the score. We could do with a consistent "spec" for the docstrings which will generally answer what should be in there. My feeling is that we should have both references in the API docstring. (2) Yes, this should be changed to the DOI. (3). I'm not worried about that, it seemed quite clear how to access the PDF, but if anyone disagrees please say so. @Steph-Chong I'd be interested in your take on point 1. I'm happy to go ahead and make the change, but I wonder if I should create an issue for putting together a "spec" or template reference for the docstrings and we can then move towards a standard approach to the sections of docstrings. |
I think a spec for docstrings would be great (it is actually something I had been thinking about). We've refined our approach to docstrings over time, and I think they have gotten better as a result. But it does mean the docstrings in the API are currently a bit inconsistent. I think a spec would (a) be useful for new contributors and (b) over time we could (where necessary) update existing docstrings to match. I think it is probably worth adding it to the pull request checklist - as contributors should be looking at that as part of making a PR. It could additionally be added to the contributing guide (but that document is already very long). |
The reference in the Brier Score API is for the Wikipedia page: https://en.wikipedia.org/wiki/Brier_score.
The reference in the tutorial and included.md is Brier (1950), for which the DOI is - https://doi.org/10.1175/1520-0493(1950)078%3C0001:VOFEIT%3E2.0.CO;2
The text was updated successfully, but these errors were encountered: