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

Volker Krause vkrause at kde.org
Sun Nov 6 10:25:32 UTC 2016


On Friday 04 November 2016 14:54:25 Volker Krause wrote:
> Hi,
> 
> On Thursday 03 November 2016 11:38:21 Friedrich W. H. Kossebau wrote:
> > 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
> 
> is this part of the KF5 style-guide? If so, I wasn't aware of that, sorry.
> 
> > 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
> 
> Well, there's at least a dozen or so other frameworks (in particular, newer
> ones) with similar patterns. So it doesn't look like we are the odd
> exception here.
> 
> > 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.
> 
> I don't mind doing the extra work, but I need input on whether this is
> actually desired or considered "legacy style". David?

The namespace has a K prefix now.

Regards,
Volker
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 173 bytes
Desc: This is a digitally signed message part.
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20161106/511b79bc/attachment.sig>


More information about the Kde-frameworks-devel mailing list