search

denoland / std

The Deno Standard Library
https://jsr.io/@std
MIT License
3k stars 598 forks source link

docs: add a note about error message format exception #5797

Closed irbull closed 2 weeks ago

irbull commented 2 weeks ago

The assertion package uses a period at the end of the error message. While this doesn't conform to the standard error message format, it would be a breaking change to adjust this now. This change-set adds a note to the CONTRIBUTING.md file to explain this exception.

https://github.com/denoland/std/issues/5574

codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.23%. Comparing base (c817a5a) to head (badbac1). Report is 12 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #5797 +/- ## ======================================= Coverage 96.23% 96.23% ======================================= Files 480 480 Lines 38748 38748 Branches 5616 5616 ======================================= Hits 37291 37291 Misses 1416 1416 Partials 41 41 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

kt3k commented 2 weeks ago

Inline comment on every file feels a bit excessive. Can you only add Exceptions section in contributing guide?

irbull commented 2 weeks ago

Inline comment on every file feels a bit excessive. Can you only add Exceptions section in contributing guide?

Sounds good. I've updated the PR and rebased it on main as well.