Skip to content

Commit 8d7842e

Browse files
epwalshgithub-actions[bot]
authored andcommitted
chore(docs): auto generate docs
1 parent 210874b commit 8d7842e

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

doc/obsidian_api.txt

+20-1
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ Find all tags starting with the given term(s).
256256
Parameters ~
257257
{term} `(string|string[])`
258258
{opts} `(obsidian.SearchOpts|boolean|?)` search options or a boolean indicating if sorting should be used
259-
{timeout} `(integer|?)`
259+
{timeout} `(integer|?)` Timeout in milliseconds.
260260

261261
Return ~
262262
obsidian.TagLocation[]
@@ -271,6 +271,25 @@ Parameters ~
271271
{opts} `(obsidian.SearchOpts|boolean|?)` search options or a boolean indicating if sorting should be used
272272
{callback} `(fun(tags: obsidian.TagLocation[]))`
273273

274+
------------------------------------------------------------------------------
275+
*obsidian.Client.list_tags()*
276+
`Client.list_tags`({self}, {timeout})
277+
Gather a list of all tags in the vault.
278+
279+
Parameters ~
280+
{timeout} `(integer|?)` Timeout in milliseconds.
281+
282+
Return ~
283+
`(string[])`
284+
285+
------------------------------------------------------------------------------
286+
*obsidian.Client.list_tags_async()*
287+
`Client.list_tags_async`({self}, {callback})
288+
An async version of 'list_tags()'.
289+
290+
Parameters ~
291+
{callback} `(fun(tags: string[]))`
292+
274293
------------------------------------------------------------------------------
275294
*obsidian.Client.apply_async()*
276295
`Client.apply_async`({self}, {on_note}, {on_done}, {timeout})

0 commit comments

Comments
 (0)