[Contributing] Fix Coding Standards example (esp. null return vs. void) #12974
Conversation
This file contains hidden or 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
guilliamxavier
commented
Jan 23, 2020
|
What's the matter with the "DOCtor-RST" lint failing? |
|
@guilliamxavier you can ignore the DOCtor-RST linter errors for this pull request. About the proposed changes, let's ask @nicolas-grekas and @stof for a review. Thanks! |
guilliamxavier
commented
Jan 28, 2020
guilliamxavier
commented
Jan 28, 2020
guilliamxavier
commented
Jan 28, 2020
| * @param bool $theSwitch Some switch to control the method's flow | ||
| * | ||
| * @return bool|void The resultant check if $theSwitch isn't false, void otherwise |
There was a problem hiding this comment.
Note: I have seen some @return void in the code, but below is explicitly stated
Omit the
@returntag if the method does not return anything
|
@nicolas-grekas: Thank you for reviewing, I have applied your suggested changes |
OskarStark
approved these changes
Feb 25, 2020
|
Thank you @guilliamxavier. |
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.
Fix inconsistent return points and make the logic a bit more realistic (even if still dummy code)