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
I have noticed some inconsistencies and grammar mistakes with respect to the use of the acronym, "URL" and the correct article use, e.g. "... an URL alias" should be "... a URL alias".
Even though URL is an acronym, class-naming standards dictate that acronyms in class names should be capitalized. This means that the class \Drupal\Core\Url is properly capitalized. So when documentation refers to Url objects, this is a proper capitalization and should not be modified.
Also, 'URL' is an acronym, so should consistently be spelled 'URL', not 'url' or 'Url' in text visible in the UI. Ideally, we should also fix this in comments, etc, but good care should be taken to avoid accidentally hitting anything code-affecting (annotations, array keys, etc).
Remaining tasks
- None
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.