Please add consistency in naming of (noK)Syntax(-)Highlighting library

Friedrich W. H. Kossebau kossebau at kde.org
Thu Nov 3 10:38:21 UTC 2016


Hi,

one of the things we praise about Qt is the predictability of class names and 
methods names. Because the patterns used with them decrease the amount of 
knowledge one needs to have, as things can be derived. No need to look up in a 
dictionary, just take the base name and apply a common pattern.

When hearing about the new KDE Frameworks library for syntax highlighting, I 
expected I could derive the name of the lib as with the other KDE Frameworks 
libraries with a generic name:
- repo ksyntaxhighlighting
- namespace KSyntaxHighlighting

But now I learned that I have to remember some extra rules in my mind:
- syntax highlighting: no k-prefix
- syntax highlighting: there is a hyphen in the repo name

Creating software means dealing with complex systems. Every extra 
irregularities makes things only more complex, so best are avoided if 
possible.
If there are no pressing needs for the no-k-prefix and custom repo naming, 
please consider changing that still before the upcoming release in a few days. 
I know the extra work sucks, but it sucks even more for all the people running 
into the irregularly named library here in all the months and years to come.

Sorry for the late feedback, only came across it now.

Cheers
Friedrich


More information about the Kde-frameworks-devel mailing list