Errors should use a consistent voice

evilsoft / crocks

A collection of well known Algebraic Data Types for your utter enjoyment.

https://crocks.dev

ISC License

1.59k stars 102 forks source link

Closed bennypowers closed 5 years ago

bennypowers commented 5 years ago

Describe the bug Following on https://github.com/evilsoft/crocks/pull/403#discussion_r290143440, all errors should use a :corn:sistent voice, preferring active over passive voices where possible

Good: "First argument must be a Number"

Bad: "Number is required for first argument"

This is also an opportunity to fix capitalization and other grammatical nits in error messages.

To Reproduce Filed as bug since changing errors is a change to API, however there's no repro- it's strings.

bennypowers commented 5 years ago

God-willing, I'll soon put together a PR to address this.

dalefrancis88 commented 5 years ago

This is accepted and understood to be a core goal. Closing the issue