search

avajs / ava

Node.js test runner that lets you develop with confidence 🚀
MIT License
20.74k stars 1.41k forks source link

Assertion parameter names are inconsistent between documentation and declaration ("value" vs. "actual") #2938

Closed DavidAnson closed 2 years ago

DavidAnson commented 2 years ago

Documentation for the is assertion uses parameter names value and expected: https://github.com/avajs/ava/blob/6b63b1bc14a1aaa7d4ee4f2201f901624419c677/docs/03-assertions.md#L124

Declaration for the same assertion uses parameter names actual and expected: https://github.com/avajs/ava/blob/6b63b1bc14a1aaa7d4ee4f2201f901624419c677/types/assertions.d.ts#L190

This is inconsistent. I think actual/expected is more clear and more common, so suggest standardizing on that pairing.

novemberborn commented 2 years ago

Sounds good to me. Would you like to open a PR @DavidAnson?

DavidAnson commented 2 years ago

Please don't wait for me to send a PR, it's unlikely I'll have time for this soon.