Problem/Motivation
Some comments have two periods at the end of a sentence, e.g.
Warn the user that a metapackage file has been updated..
Proposed resolution
Remove extra periods at end of sentences in comments.
Remaining tasks
Postponed on #3126860: Add a sniff to fix duplicate full stops in comments
Find all the places with extra periods- Create patch to remove the extras
- Review
- Commit
User interface changes
N/A
API changes
N/A
Data model changes
N/A
Release notes snippet
N/A
| Comment | File | Size | Author |
|---|---|---|---|
| #17 | interdiff-11-17.txt | 1.58 KB | iyyappan.govind |
| #17 | 3117662-17.patch | 16.04 KB | iyyappan.govind |
| #11 | interdiff-5-11.txt | 1.28 KB | jungle |
| #11 | 3117662-11.patch | 14.17 KB | jungle |
Comments
Comment #2
amsteri commentedComment #3
id.conky commentedComment #4
init90We have more comments with such a problem(look at the screenshot). I think the optimal way is fixing them all in this issue.
Set to "Needs work" for that.
Regexp:
\w\.\.$Comment #5
JoceNeovia commentedComment #6
longwaveThanks for the patch! If you set the issue status to "needs review" then the testbot will automatically test your patch for you.
I updated the title to more accurately reflect the wider scope of this issue.
Comment #7
longwaveComment #8
longwaveComment #9
alexpottThank you for your work on cleaning up Drupal core's code style!
In order to fix core coding standards in a maintainable way, all our coding standards issues should be done on a per-rule basis across all of core, rather than fixing standards in individual modules or files. We should also separate fixes where we need to write new documentation from fixes where we need to correct existing standards. This all should be done as part of #2571965: [meta] Fix PHP coding standards in core, stage 1. A good place to start is the child issues of #2572645: [Meta] Fix 'Drupal.Commenting.FunctionComment' coding standard.
This one requires updates of the existing coder rules to detect multiple multiple fullstops. There are quite a few rules that detect fullstops on the end of comments. Once we've fixed the rules then we need to get the rules applied to core.
For background information on why we usually will not commit coding standards fixes that aren't scoped in that way, see the core issue scope guidelines, especially the note about coding standards cleanups. That document also includes numerous suggestions for scoping issues including documentation coding standards cleanups.
Contributing to the overall plan above will help ensure that your fixes for core's coding standards remain in core the long term.
Comment #10
mradcliffeI performed Novice Triage on this issue. I am leaving the Novice tag on this issue and added the Needs issue summary update tag because the issue summary should provide a little bit more detail based on @alexpott's comment regarding the next steps.
I think that this may be blocked on coder updates. Adding #2571965: [meta] Fix PHP coding standards in core, stage 1 as a parent issue might help and trying to find or create an issue to fix the rule in coder would also help relate the issues together.
Comment #11
jungleUsed single quotes to bypass phpcbf correcting
Comment #12
kristen polComment #13
kristen polThanks for the updated patch.
1) The changes look good.
2) Patch applies cleanly.
3) I found one remaining line when searching the 8.9 dev codebase after patching so moving back to "Needs work".
core/misc/tabledrag.es6.js
Comment #14
kristen polComment #15
kristen polComment #16
kristen polFound a couple more:
Comment #17
iyyappan.govindHi Folks,
I have updated the patch to fix this coding in couple of the files below
Comment #18
jungleThanks to @Kristen Pol for reviewing and thanks to @iyyappan.govind for submitting a new patch.
Todo: needs to address #16.
Comment #19
jungleBased on @alexpott's comment in #9, let's postpone this waiting for #3126860: Add a sniff to fix duplicate full stops in comments landing first
Comment #21
jungleClosed #3154903: Fix double periods at the end of sentences as a duplicate. Please credit @ju.vanderw here who filed it and submitted patch, and others if applicable. Thanks!
Comment #26
quietone commentedRemoving Novice tag because this is postponed. Adding coding standards tag and changing to a task.
Comment #29
quietone commentedComment #30
quietone commentedClosing as a duplicate of a later issue with an MR and moving credit