Drupal Core has some pretty atrocious spelling errors in it.
Now, on one hand, we're geeks. Why would spelling matter?
However, as part of reaching a global audience, misspelled English words are a real affront to folks whose first language isn't English.
Finding text through search/replace is also more of a challenge when not all of the words are consistently used.
It also just looks pretty amateur. If this is an enterprise system, we can't be filled with lots of stupid typos in the code.
This is an issue to look specifically at the errors in the comments.
Bringing over the patch from #2329703-82: [meta] Spellchecking Drupal
Comments
Comment #1
mgiffordComment #3
mgiffordLooking at #2329703-84: [meta] Spellchecking Drupal - issue 2, I found another inconsistency with use of "* Implement hook_form_alter" rather than "* Implements hook_form_alter()" in core/modules/views/views.module
Anyways, fixed the plural correction "* Implement hook_install()." in core/modules/system/tests/modules/url_alter_test/url_alter_test.install
Also, a committed patch removed the "readd" in core/modules/editor/src/Tests/EditorFileUsageTest.php which was also causing this patch to fail.
Comment #4
jhodgdonAs suggested on the parent issue, maybe we can break this up into:
1. Spelling errors in PHPDoc blocks /** */ comments, which are the documentation of our API, displayed on api.drupal.org, and are therefore at least "normal" bugs.
2. Spelling errors in in-code // comments, which are only "minor" bugs.
This patch is 121 KB, and we can prioritize (1) if it is separated from (2).
Comment #5
mgiffordThat shouldn't be too bad to re-roll for someone. I still think that it's better to just do it all at once. Breaking this down into artificially small pieces isn't going to make it that much easier to swallow.
Comment #8
rpayanmComment #11
Anonymous (not verified) commentedFirst off, this is a very nice effort. Thanks!
As to #4 and #5: as I see it, this is a widespread update of the documentation, but I'm not sure whether it would be disruptive for a lot of other patches. Only conflicts in these specific lines would cause automatic merge fails, right? I also don't think that cutting the patch into two or more pieces would be any better, since we then would have (admittedly smaller) widespread changes over a longer period of time.
I'd vote to get it in, because the merge conflicts that could arise are really easy to resolve and the chance that we introduce a new issue is non-existent.
No matter the outcome of that discussion, I reviewed the patch because I fully agree with the issue summary and I think that we should do this sooner rather than later.
Some notes out front:
- I focused on the errors, and not whether we always have full sentences, dots, commas, etc. (although I sometimes mention it anyway)
- Comment lines should not be longer than 80 characters. While I know this isn't the main focus in this issue, I don't think we should introduce new violations against the documentation guideline. We should however take in mind that fixing these will make the patch even bigger, so we might want to do this in a follow-up issue.
configured
80 chars
the tar that contains
Verify that
Govern? I'm not sure what that means. Allow probably?
createCopy() (lower camel case)
80 chars
80 chars
the
the
Remove "just" or replace the order to "Just tests" or "Only tests".
And again.
"Groupby" just seems odd like this, but I get it.
80 chars though :)
with this the signature (remove "this")
Very convenient fix to 80 chars ;)
80 chars
I find the phrasing of this comment not that great. I think that is out of scope for this issue though.
internally?
This full inline comment doesn't feel right. Probably out of scope here.
The typo is fixed.
False (capital)
And again.
Capital.
Work in progress generally means that the "stuff" doesn't fully work yet :)
The typo got fixed though.
set, modify (add comma)
non-random?
80 chars
80 chars
80 chars. Not sure how this should be fixed though.
though?
Protecting against?
80 chars (twice)
an?
Comment #12
jhodgdonTHANK YOU for that careful review!
Comment #13
rpayanmRerolled.
Comment #14
rpayanm@pjonckiere suggest
Comment #19
Anonymous (not verified) commentedThe patch provided has the TransliterationTest and the Source class in it, which is probably a rebase issue. It causes the test failures.
Comment #20
rpayanmIt is odd :/
Let me see now.
This is only the reroll.
Comment #21
rpayanmNice! :)
Then @pjonckiere suggest.
Comment #22
Anonymous (not verified) commentedGlad to see this green again. Thank you! The patch looks great already!
I tested my spot the difference skills again, and have some additional feedback:
These fixes will need to be removed, since they are taken care of in #2383871: Spellchecking Drupal - PHP. They will cause a merge conflict.
"EntityAccessControlHandlerTest". There is an "H" too much there.
Not really sure about this, but shouldn't that be "themes" without the single quote?
This should be "terms".
80 chars.
Comment #23
rpayanm1. Fixed.
2. Fixed.
3. I search on the core for "theme's" and I found many occurrence of this.
4. Same of above.
5. Fixed.
Comment #24
jhodgdonSorry, but comment #22 item 3 is incorrect. It should actually be "theme's" in that case, meaning "of the theme". Those are not errors. Probably need to take whatever you did in #23 for that back out...
Comment #25
Anonymous (not verified) commentedAh ok, my bad, I wasn't sure. But the change wasn't made in the last patch, so we are good here.
I think we'll be able to rtbc this with a final review, but I don't have enough time left just now.
Comment #26
jhodgdonI took a careful look through this entire patch.
The changes in core/modules/views/tests/modules/views_test_data/src/Plugin/views/display/DisplayTest.php are not good. They really should be using @inheritdocs doc blocks, but at least do not change them from what they were, which is better than what they were changed to.
Everything else (phew!) is OK. I can see a lot of places where additional fixes could be put in some of the lines that we are changing, but I would hate to hold this up any more. So... just take out DisplayTest from the patch and I think we're good to go. Thanks!
Comment #27
rpayanmComment #28
jhodgdonGreat!
Comment #29
alexpottDocumentation is not frozen in beta. Committed fdc1c3d and pushed to 8.0.x. Thanks!
I included
maximpodorov, Valentine94from the original patch on the commit message.Comment #31
maximpodorov commented@alexpott, thank you. I hope Drupal 7 will be patched also, soon or later.
Comment #33
pere orgaSee #2494319: Follow up to Spellchecking Drupal - Comments