Problem/Motivation
There's a typo in a WidgetInterface.php comment.
Steps to reproduce
Proposed resolution
Use SlevomatCodingStandard.Commenting.ForbiddenComments as suggested by longwave in #3126860-7: Add a sniff to fix duplicate full stops in comments
Remaining tasks
Review
Commit
User interface changes
Introduced terminology
API changes
Data model changes
Release notes snippet
| Comment | File | Size | Author |
|---|
Issue fork drupal-3486996
Show commands
Start within a Git clone of the project using the version control instructions.
Or, if you do not have SSH keys set up on git.drupalcode.org:
- 3486996-typo-in-widgetinterface.php
changes, plain diff MR !10155
Comments
Comment #3
kgaut commentedComment #4
kgaut commentedComment #5
smustgrave commentedComment #6
longwaveUsually we try to fix all instances of the same issue in one go, with a regular expression search
[^\.]\.\.$we can find all instances of two periods at the end of a line so let's try to address all these at once:Comment #7
smustgrave commentedGood point @longwave
Comment #8
kgaut commentedDone @longwave :)
Comment #9
ram4nd commentedLooks good
Comment #16
quietone commentedThanks for working to improve the readability of our comments.
This is actually a Coding standard fix and should be done by a sniff, so that we can be sure no such errors are introduced in the future. Unfortunately, this is a duplicate of an existing core issue which already has a patch, so this is duplicating existing editing and review work. Since we are already waiting on the sniff, I am closing the other issue as a duplicate because this has an MR, which is preferred and postponing on the sniff. I am also moving credit from that issue.
And updating the issue meta data to use the 'main' branch which is 11.x, and set to a 'Task' in the 'other' component which is where coding standards issues normally go and adding as a child of the Meta for PHP coding standards.
Cheers
Comment #17
quietone commentedComment #18
quietone commentedLinting passed, time for review.
Comment #19
dcam commentedAs noted in #6 there's a double stop on line 261 of tabledrag.js. But that isn't fixed in the MR. The linting that was added was a PHPCS rule, so it makes sense that this was missed. I don't suppose we have access to a JS equivalent, do we? Either way, tabledrag.js needs to be edited.
Comment #20
quietone commentedUpdated for the js file and no more instances were found with the following.
Comment #21
needs-review-queue-bot commentedThe Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".
This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.
Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.
Comment #22
quietone commentedAnother rebase, and no conflicts.
Comment #23
dcam commentedFeedback was addressed. This is RTBC.
Comment #24
quietone commentedChanged to use the regex used by Coder in #3126860: Add a sniff to fix duplicate full stops in comments
Comment #25
dcam commentedI verified that the new regex is the same that went into Coder. Then I tested PHPCS on one of the double-stops that's being patched here. Here are the results:
This looks good to me.
Comment #26
xjmComment #28
xjmCommitted to 11.x. I considered backporting it to 11.2.x without the rule with some fancy git tap-dancing, but there are also at least two merge conflicts with the fixed comments, so since this is just basically silly typos I think it's safe to leave this one as 11.x only.
Thanks everyone!