Skip to content

Capitalization: "User Agent" or "user agent" #5200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
frivoal opened this issue Jun 12, 2020 · 4 comments
Closed

Capitalization: "User Agent" or "user agent" #5200

frivoal opened this issue Jun 12, 2020 · 4 comments
Labels
editorial meta Testing Unnecessary Memory aid - issue doesn't require tests

Comments

@frivoal
Copy link
Collaborator

frivoal commented Jun 12, 2020

CSS specs are inconsistent as to whether user agent should be capitalized "user agent" or "User Agent". While this is clearly not a major issue, it would be nice to be consistent. A naive bit of grepping suggests that the all lower-case variant is more common, so I'd suggest we align the rest to that.

csswg-drafts$ grep "User Agent" */Overview.bs |wc -l
    155
csswg-drafts$ grep "user agent" */Overview.bs  | wc -l
    588
csswg-drafts$ grep "[U|u]ser agent" */Overview.bs  | wc -l
    686

(The last one is a crude attempt to capture the all lowercase variant including when it's at the start of a sentence, and capitalized for that reason.)

@frivoal
Copy link
Collaborator Author

frivoal commented Mar 29, 2021

A search an replace to capitalized is easier to perform though. And it is a special term, so having it capitalized does seem more appropriate, even if it is currently more rare. Anyway, Agenda+ to see if there's any appetite on unifying to one or the other.

@tabatkins
Copy link
Member

Seems fine to unify. The W3C style guide mandantes lowercase, tho https://w3c.github.io/manual-of-style/#Terms

@astearns astearns added this to the APAC VF2F-2021-04-08 milestone Apr 2, 2021
@css-meeting-bot
Copy link
Member

The CSS Working Group just discussed Capitalization: "User Agent" or "user agent", and agreed to the following:

  • RESOLVED: Match the style guide of lowercase for "user agent"
The full IRC log of that discussion <Rossen_> Topic: Capitalization: "User Agent" or "user agent"
<Rossen_> github: https://github.com//issues/5200
<hober> q+
<dlibby_> florian: writing some spec text and wanted consistency, but we're completely inconsistent everywhere. using fully lowercase a bit more often
<dlibby_> florian: hard to do this in an automated fashion. uppercase can be done unconditionally. maybe we don't care
<dlibby_> hober: i don't actually care, can't pretend. w3c style guide says lowercase so lets follow that
<dlibby_> hober: should update the guide or follow
<chris> regex FTW
<dlibby_> florian: hard to do in practice and hard to enforce. you might automate replacement by being sentence aware
<dlibby_> fremy: not sure i follow, maybe we can put up a warning, think its doable
<dlibby_> florian: yes sounds doable
<dlibby_> Rossen_: do we care enough to resolve one way or another
<dlibby_> TabAtkins: I volunteer florian to implement the lowercasing
<chris> I'm fairly sure zero interop bugs are caused by this
<fremy> s/not sure i follow/user agent at the start of a sentence would be User agent not User Agent, so User Agent is detectably wrong/
<dlibby_> RESOLVED: Match the style guide of lowercase for "user agent"

@frivoal
Copy link
Collaborator Author

frivoal commented Apr 26, 2021

Fixed by 32d2651
Run this command once in a while to fix automatically fixable instances and to be informed of those that need manual handling:
bin/ua-capitalization.sh */Overview.bs

@frivoal frivoal closed this as completed Apr 26, 2021
@frivoal frivoal added Testing Unnecessary Memory aid - issue doesn't require tests and removed Needs Edits labels Apr 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial meta Testing Unnecessary Memory aid - issue doesn't require tests
Projects
None yet
Development

No branches or pull requests

5 participants