Skip to content

Commit

Permalink
chore(docs): auto generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
epwalsh authored and github-actions[bot] committed Mar 11, 2024
1 parent e6b7ce1 commit 7c9a337
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions doc/obsidian_api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -557,6 +557,22 @@ Options:
representing the text to be written excluding frontmatter, and returns the lines that will
actually be written (again excluding frontmatter).

------------------------------------------------------------------------------
*obsidian.Client.write_note_to_buffer()*
`Client.write_note_to_buffer`({self}, {note}, {opts})
Write the note to a buffer.

Parameters ~
{note} obsidian.Note
{opts} { bufnr: `(integer|?,)` template: string|? }|? Options.

Options:
- `bufnr`: Override the buffer to write to. Defaults to current buffer.
- `template`: The name of a template to use if the buffer is empty.

Return ~
`(boolean)` updated If the buffer was updated.

------------------------------------------------------------------------------
*obsidian.Client.update_frontmatter()*
`Client.update_frontmatter`({self}, {note}, {bufnr})
Expand Down Expand Up @@ -925,12 +941,11 @@ Options:

------------------------------------------------------------------------------
*obsidian.Note.save_to_buffer()*
`Note.save_to_buffer`({self}, {bufnr}, {frontmatter})
`Note.save_to_buffer`({self}, {opts})
Save frontmatter to the given buffer.

Parameters ~
{bufnr} `(integer|?)`
{frontmatter} `(table|?)`
{opts} { bufnr: `(integer|?,)` insert_frontmatter: boolean|?, frontmatter: table|? }|? Options.

Return ~
`(boolean)` updated True if the buffer lines were updated, false otherwise.
Expand Down

0 comments on commit 7c9a337

Please sign in to comment.