Skip to content

Commit 66da197

Browse files
evantraversevantravers
committed
Fix documentation
1 parent 9dfc86c commit 66da197

File tree

2 files changed

+54
-54
lines changed

2 files changed

+54
-54
lines changed

‎docs.json‎

Lines changed: 53 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,16 @@
2323
"Constructor" : [
2424

2525
],
26-
"doc" : "You need in namespace a table at `config.spaces`.\n`config.spaces` is a table that is passed to a chooser.\n\nYou can specify blocking of apps via a `whitelist`, `blacklist`, and you can\nsay what you want to have `launch` when you launch that space.\n\nA space with a `blacklist` will allow anything _but_ apps tagged with the\nblacklist tags, untagged apps, or apps with a whitelisted attribute.\n\nA space with a `whitelist` will allow **only** the apps tagged with tags in\nthe whitelist, untagged apps, or apps with a whitelisted attribute.\n\nThere is presently an interaction between the two where if an app is\nwhitelisted by a tag and blacklisted by a tag, whitelist wins.\n\nThe `launch` list tells the space to auto launch certain things at startup.\n\nOptionally, you can define a setup function at config.spaces.<key> that is\nrun when the space is started.\n\nOPTIONS:\n\nIf you are using toggl timer, putting anything in quotes will pass that as a\ncustom description to toggl. e.g. Design \"Working on jira ticket\" will match\na space named Design, but pass a custom description to your timer.\n\nIf you want a pomodoro countdown, add a colon followed by integers. e.g. :45\nwill count down 45 minutes, then play a musical cue and prompt you to choose\na new space.\n\n# Example:\n\nconfig.spaces = {\n text = \"Example\",\n subText = \"More about the example\",\n image = hs.image.imageFromAppBundle('foo.bar.com'),\n\n funcs = \"example\",\n\n launch = {\"table\", \"of\", \"tags\"},\n blacklist = {\"table\", \"of\", \"tags\"},\n == OR ==\n whitelist = {\"table\", \"of\", \"tags\"}\n\n togglProj = \"id of toggl project\",\n togglDescr = \"description of toggl timer\n\n intentRequired = true\n intentSuggestions = {}\n}\n\nconfig.funcs.example = {\n setup = function()\n hs.urlevent.openURL(\"http:\/\/hammerspoon.org\")\n end\n}\n\nThe goal is to get into another space, even when working from home.\n\nFuture expansions...\nDND status?\nCustom Desktop Background with prompts for focus, writing, code?\nMusical cues?",
26+
"doc" : "You need in namespace a table at `config.spaces`.\n`config.spaces` is a table that is passed to a chooser.\n\nYou can specify blocking of apps via a `whitelist`, `blacklist`, and you can\nsay what you want to have `launch` when you launch that space.\n\nA space with a `blacklist` will allow anything _but_ apps tagged with the\nblacklist tags, untagged apps, or apps with a whitelisted attribute.\n\nA space with a `whitelist` will allow **only** the apps tagged with tags in\nthe whitelist, untagged apps, or apps with a whitelisted attribute.\n\nThere is presently an interaction between the two where if an app is\nwhitelisted by a tag and blacklisted by a tag, whitelist wins.\n\nThe `launch` list tells the space to auto launch certain things at startup.\n\nOptionally, you can define a setup function at config.spaces.<key> that is\nrun when the space is started.\n\nOPTIONS:\n\nIf you are using toggl timer, putting anything in quotes will pass that as a\ncustom description to toggl. e.g. Design \"Working on jira ticket\" will match\na space named Design, but pass a custom description to your timer.\n\nIf you want a pomodoro countdown, add a colon followed by integers. e.g. :45\nwill count down 45 minutes, then play a musical cue and prompt you to choose\na new space.\n\n# Example:\n\nconfig.spaces = {\n text = \"Example\",\n subText = \"More about the example\",\n image = hs.image.imageFromAppBundle('foo.bar.com'),\n\n funcs = \"example\",\n\n launch = {\"table\", \"of\", \"tags\"},\n blacklist = {\"table\", \"of\", \"tags\"},\n == OR ==\n whitelist = {\"table\", \"of\", \"tags\"}\n\n togglProj = \"id of toggl project\",\n togglDesc = \"description of toggl timer\n\n intentRequired = true\n intentSuggestions = {}\n}\n\nconfig.funcs.example = {\n setup = function()\n hs.urlevent.openURL(\"http:\/\/hammerspoon.org\")\n end\n}\n\nThe goal is to get into another space, even when working from home.\n\nFuture expansions...\nDND status?\nCustom Desktop Background with prompts for focus, writing, code?\nMusical cues?",
2727
"Method" : [
2828
{
2929
"doc" : "Starts the application watcher that \"blocks\" applications.\n\nReturns:\n * self",
3030
"stripped_doc" : [
3131
"Starts the application watcher that \"blocks\" applications.",
3232
""
33-
],
34-
"parameters" : [
35-
3633
],
3734
"def" : "Headspace:start() -> table",
35+
"name" : "start",
3836
"notes" : [
3937

4038
],
@@ -44,18 +42,18 @@
4442
" * self"
4543
],
4644
"desc" : "Starts the application watcher that \"blocks\" applications.",
47-
"name" : "start"
45+
"parameters" : [
46+
47+
]
4848
},
4949
{
5050
"doc" : "Kills the application watcher and any running timers.\n\nReturns:\n * self",
5151
"stripped_doc" : [
5252
"Kills the application watcher and any running timers.",
5353
""
54-
],
55-
"parameters" : [
56-
5754
],
5855
"def" : "Headspace:stop() -> table",
56+
"name" : "stop",
5957
"notes" : [
6058

6159
],
@@ -65,19 +63,18 @@
6563
" * self"
6664
],
6765
"desc" : "Kills the application watcher and any running timers.",
68-
"name" : "stop"
66+
"parameters" : [
67+
68+
]
6969
},
7070
{
7171
"doc" : "Adds a device to USBObserver's watch list\n\nParameters:\n * configTable - A table containing the spaces and applications.-\n\nReturns:\n * self",
7272
"stripped_doc" : [
7373
"Adds a device to USBObserver's watch list",
7474
""
7575
],
76-
"parameters" : [
77-
" * configTable - A table containing the spaces and applications.-",
78-
""
79-
],
8076
"def" : "Headspace:loadConfig(configTable) -> table",
77+
"name" : "loadConfig",
8178
"notes" : [
8279

8380
],
@@ -87,19 +84,19 @@
8784
" * self"
8885
],
8986
"desc" : "Adds a device to USBObserver's watch list",
90-
"name" : "loadConfig"
87+
"parameters" : [
88+
" * configTable - A table containing the spaces and applications.-",
89+
""
90+
]
9191
},
9292
{
9393
"doc" : "Sets the toggl API key.\n\nParameters:\n * key - Your toggl API key as a string.\n\nReturns:\n * self",
9494
"stripped_doc" : [
9595
"Sets the toggl API key.",
9696
""
9797
],
98-
"parameters" : [
99-
" * key - Your toggl API key as a string.",
100-
""
101-
],
10298
"def" : "Headspace:setTogglKey(key) -> table",
99+
"name" : "setTogglKey",
103100
"notes" : [
104101

105102
],
@@ -109,17 +106,18 @@
109106
" * self"
110107
],
111108
"desc" : "Sets the toggl API key.",
112-
"name" : "setTogglKey"
109+
"parameters" : [
110+
" * key - Your toggl API key as a string.",
111+
""
112+
]
113113
},
114114
{
115115
"doc" : "Stops any running toggl timers",
116116
"stripped_doc" : [
117117
"Stops any running toggl timers"
118-
],
119-
"parameters" : [
120-
121118
],
122119
"def" : "Headspace.stopToggl() -> nil",
120+
"name" : "stopToggl",
123121
"notes" : [
124122

125123
],
@@ -129,17 +127,17 @@
129127

130128
],
131129
"desc" : "Stops any running toggl timers",
132-
"name" : "stopToggl"
130+
"parameters" : [
131+
132+
]
133133
},
134134
{
135135
"doc" : "Launch an hs.chooser to select a new headspace.",
136136
"stripped_doc" : [
137137
"Launch an hs.chooser to select a new headspace."
138-
],
139-
"parameters" : [
140-
141138
],
142139
"def" : "Headspace.choose() -> nil",
140+
"name" : "choose",
143141
"notes" : [
144142

145143
],
@@ -149,7 +147,9 @@
149147

150148
],
151149
"desc" : "Launch an hs.chooser to select a new headspace.",
152-
"name" : "choose"
150+
"parameters" : [
151+
152+
]
153153
}
154154
],
155155
"Command" : [
@@ -163,11 +163,9 @@
163163
"doc" : "Launch an hs.chooser to select a new headspace.",
164164
"stripped_doc" : [
165165
"Launch an hs.chooser to select a new headspace."
166-
],
167-
"parameters" : [
168-
169166
],
170167
"def" : "Headspace.choose() -> nil",
168+
"name" : "choose",
171169
"notes" : [
172170

173171
],
@@ -177,19 +175,18 @@
177175

178176
],
179177
"desc" : "Launch an hs.chooser to select a new headspace.",
180-
"name" : "choose"
178+
"parameters" : [
179+
180+
]
181181
},
182182
{
183183
"doc" : "Adds a device to USBObserver's watch list\n\nParameters:\n * configTable - A table containing the spaces and applications.-\n\nReturns:\n * self",
184184
"stripped_doc" : [
185185
"Adds a device to USBObserver's watch list",
186186
""
187187
],
188-
"parameters" : [
189-
" * configTable - A table containing the spaces and applications.-",
190-
""
191-
],
192188
"def" : "Headspace:loadConfig(configTable) -> table",
189+
"name" : "loadConfig",
193190
"notes" : [
194191

195192
],
@@ -199,19 +196,19 @@
199196
" * self"
200197
],
201198
"desc" : "Adds a device to USBObserver's watch list",
202-
"name" : "loadConfig"
199+
"parameters" : [
200+
" * configTable - A table containing the spaces and applications.-",
201+
""
202+
]
203203
},
204204
{
205205
"doc" : "Sets the toggl API key.\n\nParameters:\n * key - Your toggl API key as a string.\n\nReturns:\n * self",
206206
"stripped_doc" : [
207207
"Sets the toggl API key.",
208208
""
209209
],
210-
"parameters" : [
211-
" * key - Your toggl API key as a string.",
212-
""
213-
],
214210
"def" : "Headspace:setTogglKey(key) -> table",
211+
"name" : "setTogglKey",
215212
"notes" : [
216213

217214
],
@@ -221,18 +218,19 @@
221218
" * self"
222219
],
223220
"desc" : "Sets the toggl API key.",
224-
"name" : "setTogglKey"
221+
"parameters" : [
222+
" * key - Your toggl API key as a string.",
223+
""
224+
]
225225
},
226226
{
227227
"doc" : "Starts the application watcher that \"blocks\" applications.\n\nReturns:\n * self",
228228
"stripped_doc" : [
229229
"Starts the application watcher that \"blocks\" applications.",
230230
""
231-
],
232-
"parameters" : [
233-
234231
],
235232
"def" : "Headspace:start() -> table",
233+
"name" : "start",
236234
"notes" : [
237235

238236
],
@@ -242,18 +240,18 @@
242240
" * self"
243241
],
244242
"desc" : "Starts the application watcher that \"blocks\" applications.",
245-
"name" : "start"
243+
"parameters" : [
244+
245+
]
246246
},
247247
{
248248
"doc" : "Kills the application watcher and any running timers.\n\nReturns:\n * self",
249249
"stripped_doc" : [
250250
"Kills the application watcher and any running timers.",
251251
""
252-
],
253-
"parameters" : [
254-
255252
],
256253
"def" : "Headspace:stop() -> table",
254+
"name" : "stop",
257255
"notes" : [
258256

259257
],
@@ -263,17 +261,17 @@
263261
" * self"
264262
],
265263
"desc" : "Kills the application watcher and any running timers.",
266-
"name" : "stop"
264+
"parameters" : [
265+
266+
]
267267
},
268268
{
269269
"doc" : "Stops any running toggl timers",
270270
"stripped_doc" : [
271271
"Stops any running toggl timers"
272-
],
273-
"parameters" : [
274-
275272
],
276273
"def" : "Headspace.stopToggl() -> nil",
274+
"name" : "stopToggl",
277275
"notes" : [
278276

279277
],
@@ -283,7 +281,9 @@
283281

284282
],
285283
"desc" : "Stops any running toggl timers",
286-
"name" : "stopToggl"
284+
"parameters" : [
285+
286+
]
287287
}
288288
],
289289
"name" : "Headspace"

‎init.lua‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
--- whitelist = {"table", "of", "tags"}
4646
---
4747
--- togglProj = "id of toggl project",
48-
--- togglDescr = "description of toggl timer
48+
--- togglDesc = "description of toggl timer
4949
---
5050
--- intentRequired = true
5151
--- intentSuggestions = {}

0 commit comments

Comments
 (0)