Skip to content

Commit a0fe470

Browse files
epwalshgithub-actions[bot]
authored andcommitted
chore(docs): auto generate docs
1 parent a6596be commit a0fe470

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

doc/obsidian_api.txt

+10-7
Original file line numberDiff line numberDiff line change
@@ -251,10 +251,10 @@ Fields ~
251251
------------------------------------------------------------------------------
252252
*obsidian.Client.find_tags()*
253253
`Client.find_tags`({self}, {term}, {opts}, {timeout})
254-
Find all tags starting with the given term(s).
254+
Find all tags starting with the given search term(s).
255255

256256
Parameters ~
257-
{term} `(string|string[])`
257+
{term} `(string|string[])` The search term
258258
{opts} `(obsidian.SearchOpts|boolean|?)` search options or a boolean indicating if sorting should be used
259259
{timeout} `(integer|?)` Timeout in milliseconds.
260260

@@ -267,28 +267,31 @@ obsidian.TagLocation[]
267267
An async version of 'find_tags()'.
268268

269269
Parameters ~
270-
{term} `(string|string[])`
270+
{term} `(string|string[])` The search term
271271
{opts} `(obsidian.SearchOpts|boolean|?)` search options or a boolean indicating if sorting should be used
272272
{callback} `(fun(tags: obsidian.TagLocation[]))`
273273

274274
------------------------------------------------------------------------------
275275
*obsidian.Client.list_tags()*
276-
`Client.list_tags`({self}, {timeout})
277-
Gather a list of all tags in the vault.
276+
`Client.list_tags`({self}, {term}, {timeout})
277+
Gather a list of all tags in the vault. If 'term' is provided, only tags that partially match the search
278+
term will be included.
278279

279280
Parameters ~
280-
{timeout} `(integer|?)` Timeout in milliseconds.
281+
{term} `(string|?)` An optional search term to match tags
282+
{timeout} `(integer|?)` Timeout in milliseconds
281283

282284
Return ~
283285
`(string[])`
284286

285287
------------------------------------------------------------------------------
286288
*obsidian.Client.list_tags_async()*
287-
`Client.list_tags_async`({self}, {callback})
289+
`Client.list_tags_async`({self}, {callback}, {term})
288290
An async version of 'list_tags()'.
289291

290292
Parameters ~
291293
{callback} `(fun(tags: string[]))`
294+
{term} `(string|?)`
292295

293296
------------------------------------------------------------------------------
294297
*obsidian.Client.apply_async()*

0 commit comments

Comments
 (0)