Rename example to test case in many places#4631
Rename example to test case in many places#4631Liam-DeVoe wants to merge 2 commits intoHypothesisWorks:masterfrom
example to test case in many places#4631Conversation
|
Hmm. I feel pretty good about generally tidying up our language and settling on specific names for things, but I think I'd want to have a more complete view before shipping it. Maybe we should write up explicit "user glossary" and "contributor glossary" docs to identify what terms need definitions or explanation? Explaining existing use of terms is already a nice improvement on the status quo; and then after that we can decide whether it's worth changing some of them. (e.g.: I find all of 'example', 'input', and 'test case' natural in slightly different situations 🙈) |
|
My thoughts:
It's tempting to harmonize |
I'm interested to hear what people think about this one.
A concern I have is
max_examplesbecomes more confusing to users when everything else refers to "test cases". I think this is fine, becausemax_examplesis one of the first keywords a user learns in hypothesis (just after "strategies"), and likely before they encounter "test cases". So the confusion is when they first encounter "test cases", notmax_examples. And we already use test cases in some places, so I mostly view this as pushing the confusion earlier, not new disharmony. (to be clear I don't necessarily think this is good, just not as bad as it could be.)I've also made these two not-strictly-related wording changes (falsifying -> failing, drop "trying"), in trying to give some love to our debug logging:
Falsifying example: test_integers(->Failing test case: test_integers(Trying example: f(->Test case: f(