Skip to content

Commit b94cbcc

Browse files
committed
Improve settings actions docs
1 parent 33d5a2d commit b94cbcc

File tree

2 files changed

+24
-18
lines changed

2 files changed

+24
-18
lines changed

actions/settings.cherri

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
Settings Actions
33
*/
44

5-
// [Doc]: Set Brightness
5+
// [Doc]: [Device] Set Brightness
66
#define action setBrightness(float brightness: 'WFBrightness')
77

8-
// [Doc]: Set Volume
8+
// [Doc]: [Device] Set Volume
99
#define action setVolume(float volume: 'WFVolume')
1010

11-
// [Doc]: Turn On Do Not Disturb
11+
// [Doc]: [Notifications] Turn On Do Not Disturb
1212
#define action 'dnd.set' DNDOn() {
1313
"Enabled": 1,
1414
"FocusModes": {
@@ -17,7 +17,7 @@ Settings Actions
1717
}
1818
}
1919

20-
// [Doc]: Turn Off Do Not Disturb
20+
// [Doc]: [Notifications] Turn Off Do Not Disturb
2121
#define action 'dnd.set' DNDOff() {
2222
"Enabled": 0,
2323
"FocusModes": {
@@ -26,25 +26,25 @@ Settings Actions
2626
}
2727
}
2828

29-
// [Doc]: Set Appearance to Light
29+
// [Doc]: [Appearance] Set Appearance to Light
3030
#define action 'appearance' lightMode() {
3131
"operation": "set",
3232
"style": "light"
3333
}
3434

35-
// [Doc]: Set Appearance to Dark
35+
// [Doc]: [Appearance] Set Appearance to Dark
3636
#define action default 'appearance' darkMode() {
3737
"operation": "set",
3838
"style": "dark"
3939
}
4040

41-
42-
/* Wallpaper */
43-
41+
// [Doc]: [Wallpaper] Set Wallpaper: Sets the device wallpaper to `input`.
4442
#define action 'wallpaper.set' setWallpaper(variable input: 'WFInput')
4543

44+
// [Doc]: [Wallpaper] Get Wallpapers: Get device wallpapers.
4645
#define action default !mac v16.2 'posters.get' getAllWallpapers(): array
4746

47+
// [Doc]: [Wallpaper] Get Wallpaper: Get current device wallpaper.
4848
#define action !mac v16.2 'posters.get' getWallpaper() {
4949
"WFPosterType": "Current"
5050
}

actions_std.go

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2198,44 +2198,50 @@ var toggleSetActions = map[string]actionDefinition{
21982198
},
21992199
"Appearance": {
22002200
doc: selfDoc{
2201-
category: "settings",
2201+
category: "settings",
2202+
subcategory: "Appearance",
22022203
},
22032204
identifier: "appearance",
22042205
},
22052206
"Bluetooth": {
22062207
doc: selfDoc{
2207-
category: "settings",
2208+
category: "settings",
2209+
subcategory: "Wireless",
22082210
},
22092211
identifier: "bluetooth.set",
22102212
setKey: "OnValue",
22112213
},
22122214
"Wifi": {
22132215
doc: selfDoc{
2214-
category: "settings",
2216+
category: "settings",
2217+
subcategory: "Wireless",
22152218
},
22162219
identifier: "wifi.set",
22172220
setKey: "OnValue",
22182221
},
22192222
"CellularData": {
22202223
doc: selfDoc{
2221-
title: "Cellular Data",
2222-
category: "settings",
2224+
title: "Cellular Data",
2225+
category: "settings",
2226+
subcategory: "Wireless",
22232227
},
22242228
identifier: "cellulardata.set",
22252229
setKey: "OnValue",
22262230
},
22272231
"NightShift": {
22282232
doc: selfDoc{
2229-
title: "Cellular Data",
2230-
category: "settings",
2233+
title: "Night Shift",
2234+
category: "settings",
2235+
subcategory: "Display",
22312236
},
22322237
identifier: "nightshift.set",
22332238
setKey: "OnValue",
22342239
},
22352240
"TrueTone": {
22362241
doc: selfDoc{
2237-
title: "Cellular Data",
2238-
category: "settings",
2242+
title: "True Tone",
2243+
category: "settings",
2244+
subcategory: "Display",
22392245
},
22402246
identifier: "truetone.set",
22412247
setKey: "OnValue",

0 commit comments

Comments
 (0)