Skip to content
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

Should abbreviations be capitalized in mixedCase? #3391

Closed
fulldecent opened this issue Jan 14, 2018 · 4 comments
Closed

Should abbreviations be capitalized in mixedCase? #3391

fulldecent opened this issue Jan 14, 2018 · 4 comments

Comments

@fulldecent
Copy link
Contributor

fulldecent commented Jan 14, 2018

From: https://github.com/ethereum/solidity/blob/develop/docs/style-guide.rst.

Two (among many) capitalization techniques are defined:

  • CapitalizedWords (or CapWords)
  • mixedCase (differs from CapitalizedWords by initial lowercase character!)

And shortly following is the note:

When using abbreviations in CapWords, capitalize all the letters of the abbreviation. Thus HTTPServerError is better than HttpServerError.

Please strengthen this note to one of either:

  1. When using abbreviations in CapWords (or mixedCase), capitalize all the letters of the abbreviation. Thus HTTPServerError is better than HttpServerError.

  2. When using abbreviations in CapWords, capitalize all the letters of the abbreviation. Thus HTTPServerError is better than HttpServerError. This does not apply to mixedCase.

  3. When using abbreviations in CapWords, capitalize all the letters of the abbreviation. Thus HTTPServerError is better than HttpServerError. This applies to mixedCase too, with the exception of that the first word/abbreviation must still be lowercase.

@fulldecent
Copy link
Contributor Author

Do you think choice 1 is better?

@fulldecent
Copy link
Contributor Author

Do you think choice 2 is better?

@fulldecent
Copy link
Contributor Author

Do you think choice 3 is better?

@fulldecent
Copy link
Contributor Author

References: golang/go#23600

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant