christofmuc / KnobKraft-orm

The KnobKraft Orm - The free modern cross-platform MIDI Sysex Librarian
GNU Affero General Public License v3.0
207 stars 27 forks source link

Consistency: Wording and naming style #240

Open bboc opened 1 year ago

bboc commented 1 year ago

There is a bit of confusion going on with the adapt(at)ion that should be fixed: is it adaption, or adaptation? I guess it's the latter, but then the directory for adaptations should be renamed.

Also there should be a consistent style for the names of the adaptations, at the moment there's spaces and underscores, and combined with variations of CamelCase. Some examples:

Since we're talking Python modules, I suggest following PEP8.

Or, you prefer to have the correct names, at least consistently use spaces (and not underscores) between words, and use capitalization and hyphens they way the manufacturer named the device (which can be seen on the device or at in the manual):

christofmuc commented 1 year ago

Completely correct. The confusion stems from the fact that first I called it adaptions, and then later learned adaptations would have been correct. I renamed it everywhere except in the directory name fearing update or upgrade problems. We probably should fix that.

And yes, the Python file names were originally not visible, so I used the nice display name, but when they became external I missed the opportunity to cleanup, and now any update is in danger of screwing up big time in case the installer doesn't remove the old files correctly. Admittedly, I just didn't dare to touch them.

I'll keep this open, maybe I'll get an idea how to do this in a safe way.

bboc commented 1 year ago

@christofmuc I think renaming the adaptation directory and renaming the files might go together well. When a new version of the Orm encounters the old directory, it simply deletes it, and installs the new directory. The new directory will contain the new names. Or am I missing something?

christofmuc commented 1 year ago

I renamed the wrong adaptions to adaptations now. The good news is that this never reached the target computer, because the installer always create an adaptation directory. The bad news is that we then need to rename each file individually to make sure the prior version is removed by the installer one by one.