Document Kirigami.Theme Better
ClosedPublic

Authored by zanny on Nov 9 2019, 3:53 AM.

Details

Summary

Working on a tertiary project I ran into how Kirigami.Theme has depreciated colors that aren't documented as such on the apidox. The current discoverability of this is that a user would browse the docs to Theme from the index, start using depreciated colors, get warnings, and only then discover that Kirigami.Theme is attached - probably via this blog post by @mart.

This adds a blurb describing how the property is attached and one should refer to and use PlatformTheme for contemporary color management.

There might be a bug here, though -"Remarks: This component is a singleton" is duplicated when I build this locally and it runs on to the first paragraph. Not sure if its just a quirk in my apidox builder setup.

Diff Detail

Repository
R169 Kirigami
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
zanny created this revision.Nov 9 2019, 3:53 AM
Restricted Application added a project: Kirigami. · View Herald TranscriptNov 9 2019, 3:53 AM
Restricted Application added a subscriber: plasma-devel. · View Herald Transcript
zanny requested review of this revision.Nov 9 2019, 3:53 AM
zanny edited the summary of this revision. (Show Details)
zanny edited the summary of this revision. (Show Details)
zanny edited the summary of this revision. (Show Details)
apol accepted this revision.Nov 11 2019, 3:31 AM
apol added a subscriber: apol.

Looks like an improvement.

This revision is now accepted and ready to land.Nov 11 2019, 3:31 AM
davidedmundson accepted this revision.Nov 26 2019, 11:56 AM
davidedmundson added a subscriber: davidedmundson.

Do you have commit access? If not can I have your email address?

No commit access, email is matt.scheirer@gmail.com

Thanks for the patch!

This revision was automatically updated to reflect the committed changes.