PHP/NoSilencedErrors: add XML documentation#2694
Open
rodrigoprimo wants to merge 3 commits intoWordPress:developfrom
Open
PHP/NoSilencedErrors: add XML documentation#2694rodrigoprimo wants to merge 3 commits intoWordPress:developfrom
rodrigoprimo wants to merge 3 commits intoWordPress:developfrom
Conversation
- Fix the title to match the sniff name. - Be specific about the @ operator in the standard description. - Mention the exception for certain functions without listing them. - Simplify the code examples to focus on the presence/absence of @. - Rename the variable from $conn_id to $connection as `ftp_connect()` does not return a connection ID.
Following the suggestion in PR 2687, improve the standard description to explain why the error silencing operator should not be used instead of just repeating the rule.
Collaborator
Author
|
Just noting here that, following what was suggested in #2687 (review), I added a new commit that expands the standard description to explain why the rule exists. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
This PR adds XML documentation for the
WordPress.PHP.NoSilencedErrorssniff.The documentation is based on the work started by @gogdzl in #2495. I squashed the original commit and, in a separate commit, applied the changes suggested during the review of #2495:
@operator in the standard description.@.$conn_idto$connection.I suggest squashing the two commits before merging. I'm opening the PR without doing that to make it easier to tell my changes apart from the original changes.
Suggested changelog entry
N/A
Related issues/external references
Related to: #1722
Supersedes: #2495
Closes #2495