Generic/UselessOverridingMethod: improve XML documentation #922
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
Generic/UselessOverridingMethod: fix syntax errors in the documentation
This commit fixes two syntax errors in the PHP code examples in the sniff documentation.
Previously, the provided code would cause the following PHP error:
Generic/UselessOverridingMethod: improve documentation description and titles
<documentation>
title now matches the sniff title.<standard>
description uses 'discouraged' instead of 'should not' as this sniff raises a warning, not an error.<standard>
description and<code>
titles.Suggested changelog entry
Generic.CodeAnalysis.UselessOverridingMethod: minor fixes and improvements to the XML documentation
Types of changes
PR checklist