Rename “short name” to “key”

azuyalabs / yasumi

The easy PHP Library for calculating holidays

https://www.yasumi.dev

Other

1.05k stars 155 forks source link

Rename “short name” to “key” #221

Closed c960657 closed 4 years ago

c960657 commented 4 years ago

I am not a fan of the term “short name”.

It is not very short. Apart from spaces, it has the same length as the English localised name.
It is not the same kind of “name” as is used in the method name getName() but rather an identifier/key.

So I suggest renaming the concept to “key”. I have kept the public property Holiday#shortName for BC. This is now deprecated and will be renamed to $key (and made private/protected) in a future major release.

stelgenhof commented 4 years ago

Thanks! For sure it is not always short. At the time I considered this to be a reasonable name, however doesn't really fit any longer.