Skip to content

[Standards] Improve code standards about exception and error messages #18134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
javiereguiluz merged 1 commit into from
Mar 29, 2023
Merged

[Standards] Improve code standards about exception and error messages #18134

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions contributing/code/standards.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,12 @@ Structure

* Exception and error message strings must be concatenated using :phpfunction:`sprintf`;

* Exception and error messages must not contain backticks, even when referring to a
technical element (such as a method name for example). Double quotes must be used
at all time;

* Exception and error messages must start with a capital letter and finish with a dot ``.``;
Copy link
Contributor

@94noni 94noni Mar 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this also be defined for deprecation messages?


* Do not use ``else``, ``elseif``, ``break`` after ``if`` and ``case`` conditions
which return or throw something;

Expand Down