Naming consideration (capitalization)

I’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 be CreateQRCode() for consistency’s sake.
• ECCLevel uses the three letter acronym ECC which should therefore be written as EccLevel.

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?

[epsitec]

@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.

[codebude]

Postponed. Maybe implemented in the next major release.