@@ -251,10 +251,10 @@ Fields ~
251
251
------------------------------------------------------------------------------
252
252
*obsidian.Client.find_tags()*
253
253
`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).
255
255
256
256
Parameters ~
257
- {term} `(string |string [])`
257
+ {term} `(string |string [])` The search term
258
258
{opts} `(obsidian.SearchOpts|boolean |?)` search options or a boolean indicating if sorting should be used
259
259
{timeout} `(integer|?)` Timeout in milliseconds.
260
260
@@ -267,28 +267,31 @@ obsidian.TagLocation[]
267
267
An async version of 'find_tags()'.
268
268
269
269
Parameters ~
270
- {term} `(string |string [])`
270
+ {term} `(string |string [])` The search term
271
271
{opts} `(obsidian.SearchOpts|boolean |?)` search options or a boolean indicating if sorting should be used
272
272
{callback} `(fun(tags: obsidian.TagLocation[]))`
273
273
274
274
------------------------------------------------------------------------------
275
275
*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.
278
279
279
280
Parameters ~
280
- {timeout} `(integer|?)` Timeout in milliseconds.
281
+ {term} `(string |?)` An optional search term to match tags
282
+ {timeout} `(integer|?)` Timeout in milliseconds
281
283
282
284
Return ~
283
285
`(string [])`
284
286
285
287
------------------------------------------------------------------------------
286
288
*obsidian.Client.list_tags_async()*
287
- `Client.list_tags_async` ({self} , {callback} )
289
+ `Client.list_tags_async` ({self} , {callback} , {term } )
288
290
An async version of 'list_tags()'.
289
291
290
292
Parameters ~
291
293
{callback} `(fun(tags: string[]))`
294
+ {term} `(string |?)`
292
295
293
296
------------------------------------------------------------------------------
294
297
*obsidian.Client.apply_async()*
0 commit comments