cairo-contracts icon indicating copy to clipboard operation
cairo-contracts copied to clipboard

Standardize format for library error messages

Open ericnordelo opened this issue 3 years ago • 1 comments

Currently, we have some small inconsistencies like Account: no reentrant call and ReentrancyGuard: reentrant call, that is, for example, an inconsistency between describing the expected behavior vs describing the issue.

I think we should always use the describing the issue version (ReentrancyGuard: reentrant call in the example), besides following the "{namspace}: {issue}" format and always in the present tense.

We can add an entry to the CONTRIBUTING guide for this, what are your thoughts @martriay @andrew-fleming?

ericnordelo avatar Oct 05 '22 14:10 ericnordelo

No arguments from me—I agree with using the describing the issue approach and keeping the error messages consistent. If this is accepted, I'd suggest that we be mindful to try and include these changes before the next breaking-changes release

andrew-fleming avatar Oct 05 '22 16:10 andrew-fleming

Superseded by #696

martriay avatar Nov 05 '23 06:11 martriay