
Problem/Motivation
Both "its" and "it's" are words; the spellchecker meta wouldn't find these errors.
Proposed resolution
Research and fix (as necessary) the spelling of this word in all occurrences in core.
This does not involve any change to real code, so no tests are required for this patch.
Remaining tasks
Get patch to RTBC.
Commit patch.
User interface changes
None.
API changes
None.
Data model changes
None.
Original report by @vegantriathlete
block.css has the possessive "its" spelled incorrectly in the comment.
This is a follow-up to discussion in:
https://www.drupal.org/node/2829484#comment-11791203
https://www.drupal.org/node/2829484#comment-11854064
Comment | File | Size | Author |
---|---|---|---|
#41 | 2857857-41.patch | 18.21 KB | snehi |
#41 | interdiff.txt | 604 bytes | snehi |
#30 | 2857857-28.grep_.txt | 55.14 KB | plach |
#27 | replace_text_in_core.png | 224.88 KB | venkatesh rajan.j |
#25 | 2857857-25.patch | 18.63 KB | jofitz |
Comments
Comment #2
vegantriathleteI have looked through all the occurrences and I know what I need to correct. I've got to run right now, but will return later!
Comment #3
vegantriathleteComment #4
vegantriathleteComment #5
vegantriathleteHere are the 27 cases I considered for this patch. Not all the cases were incorrect; I had included some just to double check them since I didn't have the full context with the line that grep returned.
Comment #6
vegantriathleteComment #7
vegantriathleteComment #8
prash_98 CreditAttribution: prash_98 commentedThe patch applies cleanly in all cases and even I guess all the correction for its and it's were made in the above patch. So changing the status to RTBC .
Comment #9
xjm@prash_98, thank you for reviewing this issue!
The automated testing infrastructure tells us whether the patch applies, so we do not need people to review that. It is also not sufficient criteria for the issue to be marked "Reviewed and Tested by the Community".
When you do post a review, be sure to describe what you reviewed and how. This helps other reviewers understand why you considered the issue RTBC (and is considered for issue credit).
For this sort of issue, what would be helpful would be to follow the steps @vegantriathlete went through to create the patch, look at each instance of
it's
in core (for which @vegantriathlete helpfully provided a text file), and double-check that in each instance changingit's
toits
is correct based on the grammatical difference between them.To review this patch myself, I did a few things:
git diff --color-words
, to ensure the only changes being made were replacing gramatically incorrect uses of "it's", that the replacement with "its" was correct in context, and that the change was being made in a comment only.git diff --stat
to ensure that all were files it's allowable to change. (Certain files in core, like test fixtures and a couple of third-party libraries, aren't Drupal's to change.) The one file I hesitated about wasweb.config
, because when we make changes to this file, it's a disruptive update for sites, because sites customize the file. So we generally announce changes to the file in the release notes, etc. In this case I decided that the disruption of having a comment be grammatically improved was not worth that release notes mention and that it would not be too problematic for this comment fix to cause divergence between their custom files and core's version. I did have to think about it, though, and I'm still a little hesitant, but I think we should go ahead with it.it's
with the patch applied, to confirm for myself that these were grammatically correct ones that did not need to be fixed. I used:And I've found at least one that was missed. :) Edit: Fixed the grep and the results that still were in vendor.
// Create another field for testing with a long name. So it's storage name
I don't have the filenames handy (the
-h
on the grep specifically excludes them so there's less text to read) but they can be found easily enough with grep. There might also be more, once I found one that was missed I skimmed a bit.Thanks @vegantriathlete! Overall this is a great patch.
Comment #10
xjmAlso not such a quick fix. :)
Comment #11
prash_98 CreditAttribution: prash_98 commentedWill keep in mind @xjm
Comment #12
xjmThanks @prash_98, good luck with your future contributions!
Comment #14
xjmLooks like my --exclude-dir failed! Those misuses were in
vendor
. Checking again.Okay, confirmed that the first one is still in our code and not vendor:
I'll fix my comment above. Edit: The trailing slash was causing it to not match the directory. The updated command above fixes it.
Comment #15
xjmOne more incorrect one from the updated grep:
Comment #16
vegantriathleteD'oh! I should have done another grep myself after I had made my changes and before I created the patch. This is why we have other people review our work. Great job @xjm! I'm working on rolling a new patch (and interdiff) right now.
Comment #17
vegantriathleteThe original patch did have the change to Renderer.php. I'm not sure why #15 indicates that it was missed.
Comment #18
vegantriathleteI'll queue this up for this weekend's Drupalcamp Colorado and see about having somebody look at it on Sunday.
Comment #20
michaellenahan CreditAttribution: michaellenahan at erdfisch commentedComment #21
Skabbkladden CreditAttribution: Skabbkladden commentedThe patch can not be applied due to changes in the classes that extend Drupal\views\Plugin\views\style\StylePluginBase.
Rss.php is now inheriting documentation from StylePluginBase instead of duplicating it.
Comment #22
jofitzRe-rolled.
Comment #23
volkswagenchickPatch applied clean using simplytest.me
I reviewed the patch for use of it's versus its and all instances are appropriate.
Screen shot provided. Marking RTBC.
Thanks for improving user facing copy.
Comment #24
xjmThanks for reviewing this.
The automated testing infrastructure tells us whether the patch applies, so we do not need people to review that. It is also not sufficient criteria for the issue to be marked "Reviewed and Tested by the Community". The frontpage screenshot is also not needed since it is not relevant to this issue, which is about fixing typos in codebase documentation.
To review this, we should also check the grep to make sure we catch all of them. See #9. This time I just removed the vendor and node_modules directories and then grepped what's left:
There's also this one which may have crept in since the initial patch:
And this one:
I think those are the only two remaining that are incorrect, so if we can add this to the patch and re-review it fairly quickly, then this can probably finally land. :) Thanks everyone!
Comment #25
jofitzThe second error you highlighted has already been corrected in the previous patch (and I can't find that text anywhere else).
Comment #26
venkatesh rajan.j CreditAttribution: venkatesh rajan.j as a volunteer and at DrupalPartners commentedComment #27
venkatesh rajan.j CreditAttribution: venkatesh rajan.j as a volunteer and at DrupalPartners commented@Jo Fitzgerald thanks your patch applied cleanly
Comment #28
plachI went through the whole list following @xjm's instructions once again and I couldn't spot any other wrong occurrence. Attaching the grep output so if we need to do this again, we just need to review the diff :)
I'd like to commit this soonish, but I'll wait some time to give @xjm a chance to review the latest patch.
@Venkatesh Rajan.J:
Thanks for testing the patch but, as pointed out by @xjm a couple of times, we don't need proof that the patch can be applied: testbots will mark the issue as needing work if it doesn't.
This way of "reviewing" patches is not seen as a good practice, as adding a screenshot of the patch applied provides no useful contribution, but tricks the credit system into believing a contribution was made. I'm sure you did this in good faith but, since it seems this is becoming a common practice, you should stop doing that and tell everyone you know in the community that is doing the same to stop as well. Feel free to point them to this comment.
@xjm spent quite some time documenting in #9 and #24 how to contribute to this issue in a constructive way. Please read those comments carefully and take mental notes for the next time! You are welcome to ask help in the IRC and Slack support channels, when in doubt about how to meaningfully contribute in an issue :)
Comment #29
plachThe attachment for reals...
Comment #30
plachLast try
Comment #32
plachbot fluke
Comment #34
plachBot, this patch is changing only comments :)
Comment #36
Anonymous (not verified) CreditAttribution: Anonymous commentedBack to RTBC after random fail.
Comment #37
xjmThanks @plach for the grep results. Also uncrediting @Venkatesh Rajan.J as per the comment above.
Looks like we missed this one. :) All of the other "it's" besides that one are correct.
This one is correct, but this change will also mean that people's custom web.config files will have a conflict. So let's remove this one change from the patch (I don't think it's worth the disruption in this one case.)
Comment #38
MaskyS CreditAttribution: MaskyS at Google Code-In commentedComment #39
MaskyS CreditAttribution: MaskyS at Google Code-In commentedComment #40
MaskyS CreditAttribution: MaskyS at Google Code-In commentedComment #41
snehi CreditAttribution: snehi as a volunteer and at Publicis Sapient for Publicis Sapient commentedcovering point number 2.
Comment #42
snehi CreditAttribution: snehi as a volunteer and at Publicis Sapient for Publicis Sapient commentedNot sure about point number 1 like in which file this need to be done.
Comment #43
chiranjeeb2410 CreditAttribution: chiranjeeb2410 commented@xjm, could you specify which file needs to be addressed for the change in 1. to take place in #37 ?
Comment #44
jofitzI'm tempted to say that
// Save the recipient handler and it's settings.
does not appear in core, perhaps @plach has an additional theme or something in
/vendor
? Would you be able to confirm/deny that, @plach?I have rolled back to the codebase as it was when @plach obtained the grep results and none of the occurances of "it's" are in the codebase after
/* Make li text transparent above icon so it's clickable. */
which is in
themes/stable/css/core/dialog/off-canvas.dropbutton.css
, hence why I suspect an additional theme (or perhaps something invendor
).As a result I think this can be considered RTBC.
Comment #45
plachYes, sorry, I forgot to remove one contrib module from my sandbox. That string comes from Simplenews.
Comment #47
plachUpdating credits.
Comment #49
plachBot fluke
Comment #50
catchCommitted/pushed to 8.6.x and cherry-picked to 8.5.x. Thanks!