chore: add a note about error message format exception (#5797)

This commit is contained in:
Ian Bull 2024-08-26 00:00:27 -04:00 committed by GitHub
parent 0019ac7c78
commit d51b349381
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -257,3 +257,9 @@ Bad: Cannot compute the square root for x: value must not be negative
Good: Cannot compute the square root for x: current value is ${x}
Better: Cannot compute the square root for x as x must be >= 0: current value is ${x}
```
#### Exceptions
The assertion package uses periods to end sentences in error messages. There are
a number of downstream packages that expect this behavior and changing it would
be a breaking change.