Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
Problem/Motivation
Proposed Solution
In this issue, we are only fixing, in the API documentation (not UI text), all instances of "an URL" to "a URL" (with any capitalization of url/URL/Url etc.), without fixing the capitalization of "url".
Comment | File | Size | Author |
---|---|---|---|
#21 | interdiff-2672442-11-21.txt | 507 bytes | dimaro |
#21 | in_the_documentation-2672442-21.patch | 9.1 KB | dimaro |
#18 | in_the_documentation-2672442-18.patch | 9.09 KB | aditya_anurag |
#11 | interdiff-2672442-6-10.txt | 3.47 KB | dimaro |
#11 | in_the_documentation-2672442-10.patch | 9.1 KB | dimaro |
Comments
Comment #2
rakesh.gectcrComment #4
rakesh.gectcrApologize I did a foolish mistake changing in the vendor directory. I have re rolled again, Please review.
Comment #6
rakesh.gectcrComment #7
rakesh.gectcrComment #8
jhodgdonThanks for the issue and patch! I gather that this issue should be a child of #2574981: Fix grammar ("an URL" should be "a URL") and consistent use of URL (not "url" / "Url") in documentation only, part 1 so adding that.
Also we can update API docs in 8.0.x and 8.1.x, so changing this to an 8.0.x issue to indicate that.
The patch has some problems though, mostly due to one thing.
There is a class called "Url" that exists in Drupal Core. So even though when we're talking about a URL (in the sense of something like "https://www.drupal.org"), the correct capitalization of that is "URL", when we're talking about an object of this class, the correct phrase would be "a Url object". Or really, it should say:
a \Drupal\Core\Url object
So, I've noted where I think in the patch it's referring to the Url object and not a URL string. These all need to be updated, or at least the capitalization should not be changed to "URL" and we can make those changes to "a \Drupal\Core\Url object" in a separate issue if you prefer not to expand the scope here.
This is the object. Incorrect caps.
Object.
Object.
This change does not belong in the patch, since it is UI text. This patch should only be for API documentation. We cannot change UI text for minor things like this in 8.0.x.
Object.
Object.
Object.
Here it should probably say "a Url object" because that is what is being generated, not really a URL per se.
Comment #9
jhodgdonAs another note, I think it would be best to do the issues that fix the capitalization first, then go back and fix the "an URL" problems later, but it's up to you. You can also just only do "a" to "an" in this patch if you do not take what was correct capitalization for the object and make it incorrect. That would actually be more in keeping with the stated scope of this issue.
Comment #10
subharanjan CreditAttribution: subharanjan commentedComment #11
dimaro CreditAttribution: dimaro at La Drupalera by Emergya commented@jhodgdon According to the stated scope of this issue, I have only changed "an" to "a" in this patch.
(Task 1 in https://www.drupal.org/node/2574981 - Comment #45)
All instances of "Url" or "url" have been restored to their original state.
The URL capitalization should be performed on another issue, no? All this would be correct?
Comment #12
subharanjan CreditAttribution: subharanjan commentedComment #13
smukh CreditAttribution: smukh as a volunteer and commentedI am looking into it.
Comment #14
jeevanbhushetty CreditAttribution: jeevanbhushetty commentedThere are still issues of "Url" to "URL" and "an URL" to "a URL" in following files.
1. https://www.drupal.org/files/issues/interdiff-2672442-6-10.txt
2. https://www.drupal.org/files/issues/in_the_documentation-2672442-10.patch
3. https://www.drupal.org/files/issues/interdiff-2672442-1-2.txt
Comment #15
dimaro CreditAttribution: dimaro at La Drupalera by Emergya commented@jeevanbhushetty See #11.
I think that the URL capitalization should be performed on another issue and in this one we should just change "an" to "a".
Comment #16
jhodgdonYes, we are *only* chainging "an" to "a" when "url" (with any capitalization) follows it, and not doing anything about capitalization problems in this issue. And only in API docs, not UI text.
So the changes in the patch are fine. I also verified with grep that it fixes all instances in core of "an url" (any caps).
So thanks for the patch and for making a well-scoped issue! On to the next part in another issue? :)
Comment #17
catchNeeds a re-roll for 8.1.x.
Comment #18
aditya_anurag CreditAttribution: aditya_anurag as a volunteer and at Valuebound commentedI have re rolled against 8.1.x
Comment #19
heykarthikwithuComment #20
jhodgdonThanks! The patch in #18 looks good, and is identical to the patch in #11. Except in #11, this capitalization change shouldn't be made:
This should be "A Url object.". I missed that in my earlier review.
So... We can commit the patch in #18 to 8.1.x, and then we need to go back and make a new patch for 8.0.x. Accordingly, setting to RTBC for 8.1.x and tagging with "needs backport" for 8.0.x.
Comment #21
dimaro CreditAttribution: dimaro at La Drupalera by Emergya commentedThis it's the patch for 8.0.x
This solves a mistake indicated on #20.
Attach interdiff between #11 and #21.
Comment #23
jhodgdonThanks! So the patch in #18 should be good for 8.1.x, and #21 for 8.0.x.
Comment #25
catchCommitted/pushed to 8.1.x, thanks!
#21 doesn't apply. I'm going to go ahead and mark this fixed - can re-open if someone re-rolls.
Comment #26
jhodgdonHuh? #21 seems to apply to 8.0.x. I went ahead and committed it, after using git diff -- color-words to verify once again that all it does is change an to a before url.