Naming consideration (capitalization) about qrcoder HOT 10 CLOSED

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

from qrcoder.

Hi @epsitec ,

thanks for your feedback. In theory this is a good and justifiable proposal. Nevertheless I'm a bit scared of the user's/developer's reactions, when they have to rewrite their code after the next update.

Do you have a strategy or idea in mind, how to switch "softly"? May be we can switch by giving support for old an new naming for a while. (While marking the old named functions as obsolete like explained here: http://stackoverflow.com/a/1759357/251719)

from qrcoder.

Doing it all at once might be better that way it is just done otherwise it is just delaying the issue

from qrcoder.

I think a massive code go-through can be justifiable.

from qrcoder.

Hi @epsitec , @mrtops and @Hydroque ,

since you guys argue for renaming, let's try to do so. Before doing such breaking changes, I want to ensure, that we have to do this only one time. So can we bring up a list with all classes/methods/variables which shall be changed together? I just want to ensure that nothing is left behind.

Please add, edit, remove, proof and discuss this list. 👍

from qrcoder.

Thank you for your proposal. It seems that Microsoft has some difficulty at adhering to their own coding standards. See for instance what they did for SHA or HMAC...

https://msdn.microsoft.com/en-us/library/system.security.cryptography.hmac(v=vs.110).aspx

So, switching all acronyms to the three letter words is probably not the path to least surprise for users of Cryptography namespace.

Now I am confused.

from qrcoder.

Hi @epsitec ,
that's why I initially said, that I don't see a big "benefit". Yes, coding standards are good and everyone should try to met the standards, but it's not possible all the time.

I'm still scared, that we could put happy users off, by doing this breaking changes. On the other hand you and the others said, that the changes would make the lib more intuitive to use. But spoken for myself, when I start using a new lib, I don't know how the methods/properties are named. I have to use Intellisense/autocomplete and/or the wiki/docs to learn what methods are available and how to use them. So does renaming methods really bring the effort, when have to use docs/wiki anyway?

from qrcoder.

You might be right, after all. Removing the surprise of the Qr spelling by breaking compatibility is probably not worth it.

from qrcoder.

My intent for proposal would be looking through all the code for formatting and regulation. Not just simple name changes, but optimizations and code flow. Making a new release doesn't mean that people can't rely on the previous instance if they want. They will come to want the more additional features in the mean time. As long as the dev has good documentation over what has changed, it shouldn't be that hard to figure out.

Also, I prefer my acronyms capitalized, and leading WORDS to be lowercase.
Example
QRCoderExample and WTFToString

from qrcoder.

Postponed. Maybe implemented in the next major release.

from qrcoder.