Inconsistent Capitalisation

[Presskopp]

just came across

documentation URL, documentation page, documentation links (lower case)

while mostly we use

Documentation URL, Documentation menu, Documentation link, Documentation dropdown etc (upper case)

Then there is "site URL", "website URL"

and probably more strings.

We should be consistent here.

[audrasjb]

Good catch. I'm collecting the list of files right now, then I'll add the good-first-bug keyword :)

[audrasjb]

Here are the occurrences I found in translatable strings.

Documentation page:

• wp-admin/update-core.php

Documentation link:

• wp-admin/option-discussion.php
• wp-admin/option-writing.php

Documentation URL:
Unable to find it in translatable strings, only on translators comments.

Site/Website URL:

• wp-admin/includes/class-wp-debug-data.php
• wp-admin/includes/class-wp-privacy-policy-content.php
• wp-admin/includes/ms.php

https://core.trac.wordpress.org/ticket/53028

Trac ticket:

[arpitgshah]

I just have made changes with each of the files as per the listing.

[mukesh27]

Hi there,

We should update those translators comments like in other files. Some files there are more.

​meta-boxes.php#L705
​options-general.php#L97

Replying to audrasjb:

Here are the occurrences I found in translatable strings.

Documentation URL:
Unable to find it in translatable strings, only on translators comments.

[arpitgshah]

Hey @mukesh27 & @audrasjb

Do we need to change this translator comments or string to capitalization?

Do we also need to add comments based on your list of path with all files or need to find and add from all the folders and file?

Please confirm.

Thanks,
Arpit G Shah

[desrosj]

Reviewing this, I'm not sure that the preferred change is to always capitalize "documentation". I personally wouldn't consider "documentation" to be a proper noun.

All instances of Documentation URL in Core that I can find are at the beginning of a sentence, and all instances of documentation URL are found within sentences, so these seem to be correct. Documentation page also has 6 lowercase instances and no capitalized, which also seems to be correct.

Below is my findings on the other strings:

• Documentation link: 1 capitalized mid sentence, 7 lowercase
• Documentation link(s): 1 capitalized mid sentence, 7 lowercase
• Documentation menu: 1 capitalized mid sentence
• Documentation dropdown: 1 capitalized mid sentence
• Site URL: 3 incorrectly capitalized mid sentence, 54 correctly lower cased mid sentence.
• Website URL: 2 instances lower cased as translation context.

The more common pattern that matches what I would expect to see is only capitalized when the first word of a sentence, label, or translation string/context, and lowercase everywhere else.

Today is the beta 1 deadline for 5.8. If someone is able to refresh the patch in the next ~6 hours, we can get this one in. But otherwise I will punt to 5.9 to allow more time.

[arpitgshah]

Hey @desrosj

Can you please provide the location of the files so that we can make it easy to work.

So as per your comments as we need to do beginning of the sentence will be capitalize and mid of sentence will be small cases.

Thanks,
Arpit G Shah

[desrosj]

@arpitgshah Sorry, I'm unable to give links to every instance in the code base right now. But performing a case sensitive search using your code editor should be able to uncover all of the instances for you.

[audrasjb]

Moving to 5.9 as it needs to be updated to handle other use cases.

[audrasjb]

This ticket still needs a refresh to cover other cases. Moving to 6.0 as 5.9 beta 1 is scheduled tomorrow.

[marybaum]

AFter a cursory skim of the ticket, I'd break things down this way: leave it lower-case when talking about documentation as a concept, or a collective ("Please read the documentation!" and change to uppercase when we're talking about the Documentation Team ("For this release our Documentation Team reps suggested these people as leads.")

@davidbaumwald does that capture your distinction between proper and non-proper nouns?

(Seems to me improper nouns are the ones we don't say in family-friendly settings ;-D)

Trac ticket: https://core.trac.wordpress.org/ticket/53028

[audrasjb]

The above PR addresses the few issues highlighted by @desrosj.

[audrasjb]

Tests are passing. Self assigning for commit consideration.

[audrasjb]

In 53186:

Text Changes: Fix various inconsistent capitalization issues.

Props Presskopp, arpitgshah, mukesh27, desrosj, audrasjb, marybaum.
Fixes #53028.

Committed in https://core.trac.wordpress.org/changeset/53186

Committed in https://core.trac.wordpress.org/changeset/53186