Capitalisation of risk matrix score
Opened this issue · 2 comments
I just noticed in the tutorial for the risk matrix score, in the main body of the text, you mostly say "risk matrix score", but sometimes capitalise it as "Risk Matrix Score".
In the API docstrings, you don't seem to capitalise it and only use "risk matrix score".
Is it "risk matrix score" or "Risk Matrix Score" (as in a proper noun)?
I don't have an opinion and don't mind either way - I am just not sure which is correct.
(Obviously title case in header levels is different).
I don't know what everyone else's conventions are, but I would expect this should be Risk Matrix Score (i.e. as a proper noun) since it's referring to "the" risk matrix score, not a general category of things. I'll leave the choice to @rob-taggart however.
I think it should probably depend on whatever the chosen convention is in scores (unless there is a deliberate decision to be relaxed about it).
There are two possible ways of doing things:
- capitalise all scoring functions: e.g. "Mean Squared Error", "Brier Score"
- only capitalised where it is the name of a person (or other conventional proper nouns, such as a place name): e.g. "mean squared error", "Brier score"
I don't have a strong preference. But I do agree that within a tutorial there ought to be consistency.
@Steph-Chong , I'm happy if you go ahead an make changes, one way or another, for internal consistency within the risk matrix documentation and tutorial