Naming consideration (capitalization)
See original GitHub issueI’ve integrated QRCoder
into our project and in a few minutes I was up and running with QR codes. You’ve done a great job, thank you!
I felt immediately at home: I was expecting the two-letter QR acronym to stay as a two-letter upper case name in the source code, as recommended by the Framework Design Guidelines summarized here.
There are, however, a few small glitches where the naming is not OK:
var generator = new QRCoder.QRCodeGenerator ();
var data = generator.CreateQrCode (value, QRCoder.QRCodeGenerator.ECCLevel.Q);
var code = new QRCoder.QRCode (data);
var bitmap = code.GetGraphic (8);
CreateQrCode()
should beCreateQRCode()
for consistency’s sake.ECCLevel
uses the three letter acronymECC
which should therefore be written asEccLevel
.
There may be other such glitches in the code base, I did not check.
What do you think? Would it be OK for you to introduce breaking changes to make the library even easier to consume, by removing these small surprises?
Issue Analytics
- State:
- Created 7 years ago
- Comments:10 (4 by maintainers)
Top Results From Across the Web
Wikipedia:Naming conventions (capitalization)
This page in a nutshell: Article titles should be in sentence case, not title case. Only the first word is capitalized, except for...
Read more >Should Brand Names and Product Names Be Capitalized?
The Essential Rules on Capitalizing Brand and Product Names Always capitalize any brand name that is trademarked or particularly well-known (e.g., Coke, Pepsi) ......
Read more >3. Capitalization Rules It is impossible to give ...
3.31. Names of historical or political events used as a proper name are capitalized. 3.32. A vivid personification is capitalized.
Read more >When to Capitalize Product Names
1. Always capitalize your brand names and trademarked names. ... Capitalized brand and trademarked names help to protect your business identity and strengthen ......
Read more >How to Capitalize Proper Nouns in Your Branded Content
Keep proper nouns consistent · Treat product and event names differently from generic uses · Check reference materials to verify proper formatting.
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
@codebude, sorry for the long silence - I somehow lost track of this issue.
I don’t see any other solution than duplicating types to keep current implementations from compiling after such a major change. And who knows if type and enum names have not been persisted under some form or another, and what it would mean to break deserialization…
Obsoleting the misnamed types and methods will certainly be useful, until the next major release where such a braking change would be acceptable.
Postponed. Maybe implemented in the next major release.