Function closing brace #110
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jrfnl
reviewed
Aug 20, 2022
There was a problem hiding this comment.
I wonder if this should have an explicit separate section or if we could add this to one of the pre-existing sections.
Looking at the pre-existing sections, there are a couple of potential places where this could be added:
- Space usage - though feels a bit odd as it would be the only one regarding blank lines.
- Remove Trailing Spaces - in this case, it's a about trailing new lines, but not necessarily a bad match.
- Brace style - doesn't feel right as the section is more about control structures with optional braces, while this rule is about function declarations. Adding it there could give the impression that the rule is not just about function declarations.
So, "Remove trailing spaces" seems the most appropriate one.
An extra paragraph there stating "there should be no trailing blank lines at the end of a function body" should suffice IMO.
I also think we can leave out the code sample as it's pretty clear what that means.
dingo-d
force-pushed
the
function-closing-brace
branch
2 times, most recently
from
b650342 to
da9ba4f
Compare
jrfnl
reviewed
Aug 26, 2022
Co-authored-by: Juliette <[email protected]>
dingo-d
force-pushed
the
function-closing-brace
branch
from
f4387fa to
46560be
Compare
jrfnl
approved these changes
Aug 26, 2022
There was a problem hiding this comment.
LGTM
Merging this now as @GaryJones is AFK for the next few weeks. If needs be, additional textual tweaks can still be made in a follow up commit.
jrfnl
added a commit
to WordPress/WordPress-Coding-Standards
that referenced
this pull request
Oct 28, 2022
…ose brace > 1. There should be no blank line between the content of a function and the function’s closing brace. Includes removing this rule from the WPCS native ruleset in which we already enforced it (as it will now be inherited from the `WordPress` ruleset). Refs: * https://make.wordpress.org/core/2020/03/20/updating-the-coding-standards-for-modern-php/ - Function closing brace section * https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/#remove-trailing-spaces * WordPress/wpcs-docs#110 Loosely related to #1101
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR depends on #109. Once that is merged, this PR should be rebased to the master branch.
The PR adds rules about the function closing brace and is the continuation of the additions of 'modern' PHP code in the WordPress PHP Coding Standards handbook based on the make post by Juliette Reinders Folmer.