Problem/Motivation
Spelling inconsistencies in API documentation in two cases: \Drupal\Core\Url class and URL
The scope has been reduced based on comments from other contributors.
Proposed resolution
- Fix most uses of url/URL/Url in core, but does not have to fix all of them to be committed.
- Consistently use "a" rather than "an": "a URL".
- Generally use "URL" in generic text, such as "an absolute URL" or "a URL object". See #114
- Use the fully qualified class name when referring to a class, such as Drupal\Core\Url. See #114
- Be careful when "url" refers to a literal string, such as when documenting the expected keys of an array.
Remaining tasks
- Address points raised in #125
- Review
- Commit
Concerns
Testing issues: Selenium/Webdriver tests may operate in a non-English installation where checkboxes, etc, may be selected by a label (makes tests much more readable) or tests may wait for a confirmation message. But when the label/message changes (back to English, due to lost translations), tests fail. Such tests may just be in various projects, not in core, so updating trivial strings should ideally include fixing .po files at the same time.
Trivial changes like this tend to cause conflicts when merging other, more important, changes.
We have plenty of bigger fish to fry.
Where do we stop?
- @Mile23 answered the question regarding scope in #91 summarized in the proposed resolution about keeping Url when referencing as an object compared to grammar of URL as an acronym.
- @wengerk addressed this in the patch in #95.
User interface changes
None
API changes
No structural changes.
Data model changes
No structural changes.
Original report by LoMo
Comment | File | Size | Author |
---|---|---|---|
#144 | 2574981-144.patch | 50.84 KB | _utsavsharma |
| |||
#138 | diff-124-134.txt | 35.53 KB | quietone |
#136 | 2574981-136.patch | 61.75 KB | paulocs |
#136 | interdiff-134-136.txt | 3.47 KB | paulocs |
#134 | 2574981-134.patch | 62.36 KB | vsujeetkumar |
Comments
Comment #2
LoMo CreditAttribution: LoMo as a volunteer commentedTLDR; trimmed out the "grammar lesson" and simplified a bit. I do want to find a way we can track strings better, but (something like string IDs) might need to wait for Drupal X (some future time). Clearly the current approach to how we work with translation-strings trivializes the work of translators. We should do our best (now) to try to avoid trivial string changes breaking the translation (when the meaning is clearly still the same). And we should think of what a long-term future solution might look like.
Comment #3
pguillard CreditAttribution: pguillard commentedGrammar :
It seems we have an URL more often in comments, not so much in translated strings.
Spelling :
We often also have
which is correct in regard to the Url class.
This is what I get so far...
Comment #4
pguillard CreditAttribution: pguillard commentedComment #5
justAChris CreditAttribution: justAChris as a volunteer commentedMarking this as rc deadline since this affects translations. Notes on rc deadline: https://groups.drupal.org/node/484788
Consistency in our text / terminology is definitely a good idea. Whether or not this is ready before rc1, we should see if there are any other similar wording consistency issues already filed.
Also, noting this (old) issue as it relates to translations and matching slightly different strings: #194141: Implement msgmerge type fuzzy matching
Comment #6
Manjit.SinghComment #7
Manjit.Singh@pguillard I think there is some changes in code, so no need to override in this file now.
core/lib/Drupal/Core/Menu/DefaultMenuLinkTreeManipulators.php
.Please correct me if i am wrong.
Comment #8
cilefen CreditAttribution: cilefen commentedThis issue would work better if it were separated into two issues: one for documentation and one for the UI.
Comment #9
LoMo CreditAttribution: LoMo as a volunteer commentedRe #8 Is is really necessary? It's not such a big issue that splitting it makes very much sense to me.
Re patch #7: I do see a few issues where we have a double-article "A a" or "an a", etc. In most cases, those were already in the string, but we should get them correct. Also we have comments where we changed to "A URL object", where it really is probably more correct to say "A Url object", since "Url" is the proper class name.
Comment #10
LoMo CreditAttribution: LoMo as a volunteer commentedShould have been set back to "Needs work", at least for the few lines where I spot the mentioned fixes needed. I'll maybe hit that later... need to set the table now. ;-)
Comment #11
sdstyles CreditAttribution: sdstyles at FFW commentedChanges according to #9
Comment #16
charginghawk CreditAttribution: charginghawk at Genuine commentedRerolling #11 after some cleanup.
Comment #18
justAChris CreditAttribution: justAChris as a volunteer commentedAs suggested in #8, we can split the documentation edits from the UI updates. This would allow the rc deadline tag to be changed to rc eligible for the documentation updates only. Then, a separate issue for the UI updates can be filed, which should be postponed until 8.1.x dev is opened.
@LoMo, what do you think of that approach, or should we really keep this all together and postpone everything?
Additionally, this one doesn't follow our pattern and should be updated
Comment #19
cilefen CreditAttribution: cilefen commentedRe #18, if it is not split, this issue must move to 8.1.x because it modifies translatable strings.
Comment #20
pguillard CreditAttribution: pguillard commentedAs suggested by cilefen and justAChris (#8 and #18), this patch is only keeping the documentation edits.
Because I dont't see an answer from LoMo, I let you add the rc eligible tag.
Comment #21
pguillard CreditAttribution: pguillard commentedCreated the related issue for UI updates, postponed, for 8.1.x dev.
Comment #22
LoMo CreditAttribution: LoMo as a volunteer commented@justAChris Sorry, I've been "in-transit" between Germany and the U.S. the past day, so this is the first I've logged in here. I agree with the approach (splitting off the UI-visible stuff) since we missed getting this in before the RC deadline. As I initially stated, I still have reservations about this kind of "fix", anyway. This ticket was created as an example issue for the need for automation of tracking trivial changes to source strings and allowing them to be updated in all the .po files. Otherwise, the extra trouble for translators (and broken tests, etc) is just too great for the benefit of such improvements, IMHO.
Thanks for creating the 8.1.x issue, @pguillard.
Comment #23
justAChris CreditAttribution: justAChris as a volunteer commentedUpdating title to reflect that the scope of this issue is documentation only. Changing out rc deadline to rc eligible since patches containing doc improvements only are allowed during rc.
Comment #24
snehi CreditAttribution: snehi as a volunteer and at Publicis Sapient for Publicis Sapient commentedAdding more to the patch.
Comment #27
Himanshu5050 CreditAttribution: Himanshu5050 at Publicis Sapient for Publicis Sapient commentedRemoved incorrect vowels
Comment #28
Himanshu5050 CreditAttribution: Himanshu5050 at Publicis Sapient for Publicis Sapient commentedComment #30
cilefen CreditAttribution: cilefen commented@Himanshu5050 Your patch in #27 seems to have lost all the prior improvements that were in #24.
Comment #32
darol100 CreditAttribution: darol100 as a volunteer and commentedHere is a roll of #24.
Comment #33
darol100 CreditAttribution: darol100 as a volunteer and commentedComment #36
YesCT CreditAttribution: YesCT commentedchanges the case of URL the wrong way.
I think the a can be wrapped on the previous line.
case wrong here too.
and here.
missed case change.
missed the an a change
I'll work on a grep that we can use to check before and after.
Comment #37
YesCT CreditAttribution: YesCT commentedgrep -R -E "\/\/ | \* |\/\*\*| \*\/" core | grep -E " an Url| an URL| Url | url "
get's pretty close at listing them. might miss some, might overcount some.
but... in head
grep -R -E "\/\/ | \* |\/\*\*| \*\/" core | grep -E " an Url| an URL| Url | url " | wc -l
is 190
and with the patch it is
175
so there are bunch this is not catching
Comment #38
darol100 CreditAttribution: darol100 as a volunteer and commentedI have rebuild this patch with #37 suggestions.
After applying this patch if you run this command
grep -R -E "\/\/ | \* |\/\*\*| \*\/" core | grep -E " an Url| an URL| Url | url "
you are going to seeI did not edit anything on core/assets/vendor/* because we cant edit vendors files.
Comment #39
justAChris CreditAttribution: justAChris as a volunteer commentedRegarding #36.1, 3, 4, 5, those were initially left as "Url" since when referring to the Url object, the mixed case version was used. See comment #3.
However, perhaps for sake of simplicity in our conventions in documentation, it should always be uppercase URL as suggested in #36, even when referring to the object/class.
Comment #40
YesCT CreditAttribution: YesCT commentedohhhhh. hm.
Comment #41
alexpottI'm not sure about the latest patch on this issue. For example:
These are array keys.
This is just in correct as the
url()
function does not exist.It is
UrlHelper
Re the review in #36 - we need to be careful here because the Url object is
Drupal\Core\Url
. That said the class docblock from that class isDefines an object that holds information about a URL.
Comment #42
priya.chat CreditAttribution: priya.chat at Publicis Sapient for Publicis Sapient commentedComment #43
priya.chat CreditAttribution: priya.chat at Publicis Sapient for Publicis Sapient commentedComment #44
rakesh.gectcrComment #45
rakesh.gectcr@alexpott
According to your comment , I understand that we need to changes only the word
url => URL
orUrl => URL
, andan URL => a URL
.I created the new patch only with these changes.
And I am not changed in .js files
Comment #46
antojoseThis would make a good novice issue, which though simple in the task to be done, requires quite care in the fact that "url" can appear both in the comments as well as code.
Discussed this with xjm, and she suggested the following:
1) Since it has been over 3 months since the patch was made, we cannot use the patch as is. We would have to re-roll the patch for the new codebase.
2) It would be better to split this task into 3 individual tasks.
Task 1: Only in the documentation, change all instances of "an URL" to "a URL".
Task 2: Only in the documentation, change all instances of "url" to "URL".
Task 3: Only in the documentation, change all instances of "Url" to "URL".
Comment #47
jhodgdonUm. I'd just like to point out that the issue summary here and component are about UI text, not API documentation, even though the patch seems to be mostly API documentation fixes.
We should eventually fix both. So probably instead of splitting into 3 issues, we should have a 4th that is 8.1.x only, and addresses all 3 problems in UI text, if in fact there are any of those.
Oh, I see there is also a postponed (why???) child issue for the UI part. That is good.
When you make additional issues for the API docs, please:
- Make their parent issue be this issue.
- File them in component "documentation".
Meanwhile, this issue needs a new summary and the component should probably be documentation? Is this one just a "meta" (plan) issue now? I am not sure what your plan is but the issue summary and title and component do not match each other, and none of them reflects what the plan seems to be.
Comment #48
rakesh.gectcrComment #49
rakesh.gectcr#2672442: In the documentation, change all instances of "an URL" to "a URL". Ones that is fixed, I will be working on another issues.
Comment #50
justAChris CreditAttribution: justAChris as a volunteer commentedRegarding #2585989: Fix grammar and consistent use of URL / UI PART as questioned in #47, that can be un-postponed at this point. I'm fairly certain that was only postponed because the issue was created before 8.1.x was open for development. That issue affects translatable strings, which can only be updated during minor releases, so its eligibility for 8.1.x is time limited as 8.1.0 enters beta.
Comment #51
jhodgdonI'm un-postponing the other issue. While looking into whether there are additions needed to that patch, I came across one more sort-of related thing to cover in this issue: there are a lot of mentions in comments/docs about "the url() function", which no longer exists in Drupal 8. Those should also be fixed on a child issue.
Comment #52
rakesh.gectcr#2676182: In the documentation, change all instances of "url" to "URL".
Comment #54
pguillard CreditAttribution: pguillard commentedComment #55
Manjit.SinghComment #57
rajeshwari10 CreditAttribution: rajeshwari10 as a volunteer and at Blisstering Solutions commentedRerolled the patch for 8.1.x.
Comment #58
rodrigoac CreditAttribution: rodrigoac as a volunteer commentedIn line 107 still have a lower case 'url'.
Comment #59
stpaultim CreditAttribution: stpaultim as a volunteer commentedMarking this issue as "Needs work" again to account for #58.
Comment #60
Manjit.Singhchange url to uppercase. Please review.
Comment #61
dimaro CreditAttribution: dimaro at La Drupalera by Emergya commentedLooking at the child issue,
#2672442: In the documentation, change all instances of "an URL" to "a URL".
The changes applied on the latest patch would be correct?
Comment #62
Sabbi0612 CreditAttribution: Sabbi0612 at Srijan | A Material+ Company commentedHi @Manjit.Singh,
I reviewed your patch.
There were some discrepancies that I observed while testing.
The issues w.r.t the consistency of "url" keyword were on the following lines of the file "b/core/includes/form.inc"
- 252
- 239
- 504
- 509
There may be more like these.
Please Rectify.
Cheers.
Comment #63
kattekrab CreditAttribution: kattekrab at Catalyst IT commentedThis should be "no anchor tag" instead of "no a tag" as it appears here.
Comment #64
joelpittet@kattekrab, or this too: "
no <a> tag
" is acceptable to be clear, but yeah "a tag" is not clear.setting to needs work for #62 and #63
Comment #65
Manjit.SinghHere are the changes as per#63
Comment #66
joelpittet@Manjit.Singh could you run the grep command in #37, there are some new ones to fix up. Thanks for fixing #63
Comment #67
dimaro CreditAttribution: dimaro at La Drupalera by Emergya commented@Manjit.Singh @joelpittet #65 This patch is not outside the scope of the task? (Changes the different ways to show "URL")
On the other hand, I worked on the following issue #2710685: inconsistent use of tags in docs for template_preprocess_links()
I think that the latest patch apply on the same function template_preprocess_datetime_wrapper, I'm wrong?
Comment #68
Manjit.Singh@Joelpittet here we go :)
Comment #69
joelpittetThanks @Manjit.Singh, from previous patches I think the changes from
Url
toURL
are incorrect when the refer to theUrl object
, those will need to be reverted out of this patch, your latest changes look correct for the new changes though.@dimaro, I think your patch is correct thanks, that is in reference to this comment too about objects and should be reverted from this patch's scope.
Comment #70
Sumit kumar CreditAttribution: Sumit kumar at gai Technologies Pvt Ltd commentedComment #71
joelpittet@Manjit.Singh @Sumar kumar what did you change in #68 and #70, could you provide a interdiff please? Here's how if you haven't before: https://www.drupal.org/documentation/git/interdiff
Also there are still a bunch of references to
Url object
that need to be left alone and reverted from the patch please.Comment #72
Manjit.Singh@Joelpittet here is the interdiff of #65 and #67. Can you please verify and check where i have changed the object to URL.
thanks.
Comment #74
dimaro CreditAttribution: dimaro at La Drupalera by Emergya commentedRerolled the latest patch #70
Comment #76
dimaro CreditAttribution: dimaro at La Drupalera by Emergya commentedRerolled #74.
Comment #78
cilefen CreditAttribution: cilefen commentedComment #79
cilefen CreditAttribution: cilefen commented#2851394: Fix grammar 'a' to 'an' when necessary has been opened to fix all documentation "a" vs "an" problems, which I think is a worthy cause.
The most recent patch on this issue changes things like "For example", which to me seem to have nothing at all to do with the title or the issue summary. So I feel we should re-scope and refocus this issue to being 'Fix consistent use of "URL" in documentation', do only that, and let's get it done.
Please pay attention to #71. It is important to understand when we are talking about the Url class or a URL (the thing we visit in a web browser).
I am setting this to "needs work" for those changes.
Comment #80
dimaro CreditAttribution: dimaro at La Drupalera by Emergya commentedRE #79: @cilefen Thanks for your comments, I totally agree.
I think that we only should to fix the use of "URL", the latest patch no longer applies, reroll #76 against 8.4.x.
Work in progress!
Comment #82
dimaro CreditAttribution: dimaro at La Drupalera by Emergya commentedOops! Apologies.
Comment #84
joelpittetWas reviewing but the patch isn't applying and needs a reroll.
Mostly in the test files but some others as well.
Comment #85
jofitz CreditAttribution: jofitz at ComputerMinds commentedRe-rolled (and added a few more that have been introduced since the previous patch).
Comment #86
jofitz CreditAttribution: jofitz at ComputerMinds commentedForgot to remove the "Needs re-roll" tag.
Comment #87
al0aI've read through the hole patch, it does what is suppose to do.
Comment #88
mradcliffeThank you for the patch and review.
The issue is still marked as Needs issue summary update, and I agree with this. The issue summary has a section labeled "Concerns", and it looks like the scope of the issue was changed. This would probably make the issue harder to review for core commiters when they look at their RTBC issue queue. @jhodgdon mentioned it in comment #57.
Can we clarify what the scope of the issue is in the issue summary using the Issue summary template?
Comment #89
al0aComment #90
al0aComment #91
Mile23Thanks for working on this.
There are definitely scope issues here.
I only got about halfway through, so the same set of problems probably apply to other parts of the patch.
\Drupal\Core\Url is a class of object. This should remain specific to the class name.
Url (with that capitalization) refers to the \Drupal\Core\Url class.
Again, \Drupal\Core\Url is valuable information about the name of a class, and doesn't refer to a URL.
Again, in this case, Url refers to a Url object, not a URL.
E.g. is somewhat worse than 'for instance.' It's also out of scope here, so please revert this change.
Again, same class name problem.
I just wanted to point out here that an issue with scope like this should never change the documentation in a substantive way.
Please open another issue for this documentation.
Comment #93
joshmillerComment #94
leanderl CreditAttribution: leanderl at Axis Communications AB commentedI'm at the Code Sprint, DrupalCon Nashville, 2018 and will look at this issue for a bit.
The patch 2574981-85.patch doesn't work on current dev (8.6.x) and I'm not sure how to refactor it. Any tips are welcome. Is there a specific methodology for refactoring patches?
Abandoning this task, any other code sprinter is welcome to pick it up!
Comment #95
wengerkRe-rolled for 8.6.x (and added a few more that have been introduced since the previous patch).
I also apply suggestions of #91. Plus, I found a couple of others "out-of-scope addition" that I revert:
core/modules/quickedit/js/util.js
core/modules/tour/js/tour.js
As explain by #91 an issue with scope like this should never change the documentation in a substantive way.
Please open another issues for this documentation.
Comment #96
wengerkComment #97
ifrikIf I get this correctly, the use of URL in user interface text is already fixed in #2585989: Fix grammar and consistent use of URL / UI PART, and this issue is now only about the use of URL in documentation in the code?
If so the issue summary and component needs updating.
Comment #99
annajl CreditAttribution: annajl as a volunteer commentedI updated the issue summary and component to reflect the scope changes for this issue.
Comment #100
annajl CreditAttribution: annajl as a volunteer commentedComment #101
wengerkComment #102
wengerkHere is the reroll on 8.7.x
Comment #103
mradcliffeI reorganized the issue summary a bit, and added a bit about what in comment #91 answers the scope of the issue. Thank you, annajl.
I looked at the attached patch, and found this:
According to the top of that file, it shouldn't be modified manually. I ran `yarn install`, `yarn run build:js`, `yarn run prettier` but I did not get this change on latest 8.7.x.
Comment #104
wengerkThanks for spotting this !
Indeed I forget to follow the new workflow of Prettier with Core JavaScript. My bad.
Here is the correction from #103.
Comment #105
spitzialist CreditAttribution: spitzialist at Unic commentedWorking on this at #drupaleurope
Comment #106
spitzialist CreditAttribution: spitzialist at Unic commentedComment #107
spitzialist CreditAttribution: spitzialist at Unic commentedI've quickly checked the files and all changes:
- In file /core/modules/simpletest/src/WebTestBase.php, line 2004 the line "A system path or a URL." was changed to "A system path or a Url." which is not correct in my opinion. Here is should remain "A system path or a URL." from my point of view as it is not referring to the Url object. If it does refer to the Url object, one should write "Url object" to make it clear here.
- In file /core/tests/Drupal/Tests/UiHelperTrait.php, line 370 the line "A system path or a URL." was changed to "A system path or a Url." which is not correct in my opinion. Here is should remain "A system path or a URL." from my point of view as it is not referring to the Url object. If it does refer to the Url object, one should write "Url object" to make it clear here.
All other changes look fine to me and are consistent with the description of the issue.
Comment #108
izus CreditAttribution: izus commentedHi,
here is a patch that adresses #107
Thanks
Comment #109
wengerkRe: #107 & #108
Both class
UiHelperTrait
&WebTestBase
clearly need a string or an Url object (see the@param
hint), it has been change in #108 with A system path or a URL., but I kind of disagree with thoses two changes, I think it should be A system path or a Url object.What do you think ?
Comment #110
izus CreditAttribution: izus commentedHi,
following patch adresses #109
Thanks
Comment #111
wengerkThanks for the changes @izus !
For me it's RTBC. Let's see what does the community thinks about the suggestions of #107, #108 & #109.
Anyone else want to review / test / RTBC?
Thanks!
Comment #112
hugovk CreditAttribution: hugovk at Digia for Yle - Finnish Broadcasting Company commentedRTBC, LGTM!
Would be really nice to get this in before this issue's 3rd birthday on Tuesday :)
Comment #114
catchThis is inconsistent, and I think it shows that the distinction between 'an object referring to a URL' and 'an instance of the Url class' in the summary is too subtle for us apply consistently everywhere.
For me I'd just use URL everywhere, including when referring to an instance of Url (because it's an object representing a URL, so URL is as correct), and that then works for URL generator/UrlGenerator too - where the class name capitalisation is UrlGenerator/Url Generator, but in the patch it is URL generator.
Comment #115
volkswagenchickTagging for upcoming contribution days.
Comment #116
elamanLatest patch didn't apply cleanly to the HEAD. I've rerolled it also accounting for @catch'es comment.
Comment #117
Christie Alcidor CreditAttribution: Christie Alcidor as a volunteer commentedComment #118
mradcliffeHi, @Christie Alcidor. Thank you for moving this issue forward.
Could you describe what you did to review the latest patch that would make it RTBC? It helps a lot to be descriptive about what we reviewed and how, as well as any questions or doubts we had while reviewing and what the answers were. In this case I think it would help to provide a review to confirm @catch's comments were addressed by the patch in #116 and there were no unintended side effects in the patch.
Comment #119
Darren OhI have to disagree with catch’s suggestion to use URL everywhere. Using Url to refer to an instance of the Url class is a helpful distinction for me as a reader. Keeping it shows that we actually understand the documentation we create. Using URL generator to refer to implementations of the UrlGeneratorInterface interface is fine because we are describing a class rather than referring to it by name.
Comment #120
Christie Alcidor CreditAttribution: Christie Alcidor as a volunteer commented@mradcliffe it's good to use.
Comment #121
volkswagenchickComment #123
m0r1 CreditAttribution: m0r1 as a volunteer commentedChanged one comment line to capitalize URL for consistency. Caught this one with dreditor. No other changes. Just walking through the process for the first time. interdiff to come when I learn how to generate that.
Comment #124
cosmicdreams CreditAttribution: cosmicdreams at Nerdery commentedM0r1 sitting with cosmicdreams to update this patch. Changes one line on menu.api.php to capitalize URL. Did not go through the entire patch and review all cases of URL. Still needs a full review. We are releasing this patch to experience the patch release process.
Comment #125
benjifisherI have uploaded an interdiff, comparing the patches in #116 and #124. See Creating an interdiff in the Getting Involved guide.
Just looking at those differences, I notice this from the patch in #124:
This comment documents the (string) keys that can be used in an array. That is, each of these is a literal string. For ease of reading, the quotation marks have been left off, but we could have written
'route_name'
,'route_parameters'
, and'url'
. Since there is a real difference between'url'
and'URL'
, I think the change in the last line is a mistake.More broadly, I think we need to reach consensus on a few points and document these in the issue summary. (Reaching agreement will save us the trouble of making patches that are not likely to be approved. Documenting in the issue summary will make it easier for people who want to review the patches here.) Here are my recommendations:
Drupal\Core\Url
.Feel free to add to this list AND to discuss these recommendations. A few of my reasons:
I include (1) because we have a moving target and because I do not want to impose an unreasonable burden on anyone reviewing patches for this issue.
I include (3) and (4) because I agree with #114. Even if I disagreed, I would include it, since I usually defer to core committers.
Comment #128
vsujeetkumar CreditAttribution: vsujeetkumar at Srijan | A Material+ Company for Drupal India Association commentedRe-roll patch created for 9.1.x, Please review
Comment #129
Swapnil_Kotwal CreditAttribution: Swapnil_Kotwal at Asentech LLC commentedComment #131
quietone CreditAttribution: quietone as a volunteer commentedPostponed the child issue, #2676182: In the documentation, change all instances of "url" to "URL"., on resolving the points raised in #125. Note the IS for that issue says it is for the files in core/modules, although the patch covers all of core and is much that same as this one.
Comment #133
marcusvsouza CreditAttribution: marcusvsouza at CI&T commentedThe patch in comment #129 it's corrupted in line 1375 as the image attached shows.
Comment #134
vsujeetkumar CreditAttribution: vsujeetkumar at Srijan | A Material+ Company for Drupal India Association commentedRe-roll patch created for 9.3.x. and fixed that "corrupted in line 1375" issue.
Comment #135
quietone CreditAttribution: quietone as a volunteer commented@marcusvsouza, thanks for the interest in this work. The fact that the patch does not apply is not really a problem here. What needs to be done here is resolve the points raised in #125.
Comment #136
paulocsComment #137
marcusvsouza CreditAttribution: marcusvsouza at CI&T commentedThe patch on comment 136 applies correctly and meets the requirements of comment 125.
Comment #138
quietone CreditAttribution: quietone as a volunteer commentedI came back to review this issue and immediately see that the remaining task is to address the issues raised in #125. I see no discussion of that yet. I have added those points to the IS as the proposed resolution and removed the previous proposal.
I do agree with the proposed resolution.
There has been no interdiff from #124 to #134, so I have added a diff. That is not something I normally do as a reviewer.
Updated to remove the screenshot of applying a patch.
@marcusvsouza, as I mentioned in #135 the work here is to address the points in #125. Adding screenshot and comments that a patch applies does not help move an issue forward. The contributor guide on Drupal.org has information about how to contribute, particularly the process to Review a patch or merge request. There are also clear guidelines for How is credit granted for Drupal core issues. Therefore removing credit.
I hope to come back within a few days and review.
Comment #142
smustgrave CreditAttribution: smustgrave at Mobomo commentedDoes not apply to 10.1 and need to confirm the points in #125 have been addressed.
Comment #143
smustgrave CreditAttribution: smustgrave at Mobomo commentedThis needs a reroll for 10.1
Comment #144
_utsavsharma CreditAttribution: _utsavsharma at OpenSense Labs commentedRerolled for 10.1.x. Made changes against Patch #136.
These files are not present in 10.1.x:
FeedInterface.php
AggregatorTestBase.php
ckeditor.es6.js
LinkFieldRdfaTest.php
ConfirmFormTest.php
tour.es6.js
ajax_view.es6.js
base.es6.js
Comment #145
baikhoComment #146
benjifisherI asked for an issue summary update in #125. @quietone addressed that in #135 and #138, so I am removing the issue tag.
The "needs reroll" tag was added in #143. There is a new patch in #144, so I am removing that issue tag.
Creating the patch may be a Novice task, but the next steps are not, so I am removing that issue tag.
Comment #147
mlncn CreditAttribution: mlncn at Agaric for Drutopia, Teachers with GUTS commentedAmazing how much work goes into a 'simple' documentation-only consistent terminology fix!
The latest patch addresses everything in #125, in particular not incorrectly capitalizing literal string keys.
Comment #154
xjmI applied the patch locally and reviewed it with
git diff --staged --color-words
to ensure all the changes were correct and stayed within scope. The only issue I found was:Oops, typo here -- a double T.
I then grepped the codebase for instances of " url" and " Url" in documentation lines. I've manually removed things where
url
is part of a permission string or array key only (versus a word in a sentence.) There are still a LOT left with the patch applied.From:
These still have lowercase uses that need to be changed:
From:
From:
[ayrton:drupal | Thu 15:36:55] $ grep -r " Url" * | grep " \* " | grep -v "vendor" | grep -v "node_modules"
The following are outstanding. Many refer to "Url object" and might mean that in the sense that they are
Drupal\Core\Url
objects, but describing them in a sentence "URL object" is more correct if we're not using the full namespace. Or, basically, I disagree with #107 and agree with #114. :)From:
[ayrton:drupal | Thu 15:47:04] $ grep -r " Url" * | grep " // " | grep -v "vendor" | grep -v "node_modules"
That is so many things that I would actually like to commit this issue, with the "TTests" thing fixed, and then have a followup for all those other ones. So, I fixed that on commit:
So, there are two followup issues to handle, IMO. One where
url
is used in a sentence and obviously wrong, and one where we can disagree about whethera Url object
is correct or not.Meanwhile, pushed to 10.1.x, and cherry-picked to 10.0.x and 9.5.x. Thanks everyone for your persistence on this issue! Let's create those two followup issues.
Comment #155
xjmPosted #3336780: Correctly capitalize "url" in documentation only, part 2 for the first followup.
Comment #157
quietone CreditAttribution: quietone as a volunteer commentedCreated the last followup, #3357258: Correctly capitalize "Url object" in documentation only, part 3
Comment #170
quietone CreditAttribution: quietone at PreviousNext commentedI closed #2676182: In the documentation, change all instances of "url" to "URL". as a duplicate and am adding credit.