[kcmkwin/compositing] Rename Candy category to Eye Candy
AbandonedPublic

Authored by zzag on Aug 2 2018, 3:02 PM.

Details

Reviewers
ngraham
Group Reviewers
KWin
Plasma
VDG
Summary

The word "candy" doesn't fit our usecase because it means "confections
made with sugar".

"Eye candy" will fit our usecase better because it means "something that
is visually attractive or pleasing".

Test Plan

Diff Detail

Repository
R108 KWin
Branch
kcmkwin-rename-candy-to-eye-candy
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 1644
Build 1662: arc lint + arc unit
zzag created this revision.Aug 2 2018, 3:02 PM
Restricted Application added a project: KWin. · View Herald TranscriptAug 2 2018, 3:02 PM
Restricted Application added a subscriber: kwin. · View Herald Transcript
zzag requested review of this revision.Aug 2 2018, 3:02 PM
zzag edited the test plan for this revision. (Show Details)Aug 2 2018, 3:03 PM
ngraham accepted this revision.Aug 2 2018, 3:05 PM
This revision is now accepted and ready to land.Aug 2 2018, 3:05 PM

Wouldn't that break third party effects that have "Candy" in their manifest? Perhaps only change the user-visible string?

zzag abandoned this revision.Aug 9 2018, 12:47 PM

Wouldn't that break third party effects that have "Candy" in their manifest?

Oh, yeah, you're right, it will "break" 3rd-party effects. :(

Perhaps only change the user-visible string?

I'm afraid that by doing that we'll just add more mess to the code. E.g. desktopChanged(uint, uint) has been deprecated for many years and we still have it. So, there's a big chance that '// TODO: Rename to Eye Candy.' comments will be present for many years.

Let's wait for KWin 6 and maybe then rename it.

davidedmundson added inline comments.
kcmkwin/kwincompositing/model.cpp
73–74

can't we just change this one line without changing the other?

zzag added inline comments.Aug 9 2018, 1:04 PM
kcmkwin/kwincompositing/model.cpp
73–74

IMHO, if translatedCategories has "Eye Candy", then knownCategories should also have "Eye Candy".

. E.g. desktopChanged(uint, uint) has been deprecated for many years and we still have it.
Let's wait for KWin 6

FWIW we don't explicitliy offer any guaruntees.
The ABI has jumped 11 times during Plasma 5. We definitely have /some/ API breaks; though that doesn't mean we should remove deprecated things if they don't cause an issue.

kcmkwin/kwincompositing/model.cpp
73–74

then do both:

first list have:
QStringLiteral("Eye Candy"),
QStringLiteral("Candy"), //for compatibility because blah blah blah

next list have:
i18nc("Category of Desktop Effects, used as section header", "Eye Candy"),
i18nc("Category of Desktop Effects, used as section header", "Eye Candy"),

zzag reclaimed this revision.Aug 9 2018, 2:01 PM
This revision is now accepted and ready to land.Aug 9 2018, 2:01 PM
zzag updated this revision to Diff 39354.Aug 9 2018, 2:02 PM

Don't delete Candy category, just deprecate it.

zzag updated this revision to Diff 39355.Aug 9 2018, 2:16 PM

Edit comments

broulik added inline comments.Sep 17 2018, 10:38 AM
effects/effect_builtins.cpp
239

Still not a fan of actually changing the internal settings category. Changing the i18n'd user-visible labels is fine

zzag added inline comments.Sep 17 2018, 1:42 PM
effects/effect_builtins.cpp
239

I don't like that because we'll be inconsistent if we go that way.

abetts added a subscriber: abetts.Sep 17 2018, 2:24 PM

+1 for the idea

zzag added inline comments.Sep 18 2018, 1:02 PM
effects/effect_builtins.cpp
239

Just to expand: if the "Candy" category keyword doesn't match the user visible string, then other keywords should be changed, e.g.

Appearance -> appearance
Virtual Desktop Switching Animation -> virtual->desktop-switching-animation
Window Management -> window-management

etc., so there is clear split between keywords and visible user strings.

zzag abandoned this revision.Sep 21 2018, 4:28 PM

Can't we work out some agreement here? "Eye Candy" in an unambiguously better user-visible string than "Candy", and it would be a shame to not change it because of a disagreement that I'm sure we can resolve.

zzag added a comment.Aug 2 2019, 12:01 PM

I still hold my previous position.