Skip to content

Commit 89813ca

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

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

doc/obsidian_api.txt

+30-1
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,14 @@ Parameters ~
227227
Return ~
228228
obsidian.Note| `(optional)`
229229

230+
------------------------------------------------------------------------------
231+
*obsidian.Client.current_note()*
232+
`Client.current_note`({self})
233+
Get the current note.
234+
235+
Return ~
236+
obsidian.Note| `(optional)`
237+
230238
------------------------------------------------------------------------------
231239
Class ~
232240
{obsidian.TagLocation}
@@ -469,6 +477,15 @@ Add a tag to the note.
469477
Parameters ~
470478
{tag} `(string)`
471479

480+
------------------------------------------------------------------------------
481+
*obsidian.Note.add_field()*
482+
`Note.add_field`({self}, {key}, {value})
483+
Add or update a field in the frontmatter.
484+
485+
Parameters ~
486+
{key} `(string)`
487+
{value} `(any)`
488+
472489
------------------------------------------------------------------------------
473490
*obsidian.Note.from_file()*
474491
`Note.from_file`({path}, {root})
@@ -560,13 +577,25 @@ Return ~
560577
------------------------------------------------------------------------------
561578
*obsidian.Note.save()*
562579
`Note.save`({self}, {path}, {insert_frontmatter}, {frontmatter})
563-
Save note to file.
580+
Save note to file. This only updates the frontmatter and header, leaving the rest of the contents unchanged.
564581

565582
Parameters ~
566583
{path} `(string|Path|?)`
567584
{insert_frontmatter} `(boolean|?)`
568585
{frontmatter} `(table|?)`
569586

587+
------------------------------------------------------------------------------
588+
*obsidian.Note.save_to_buffer()*
589+
`Note.save_to_buffer`({self}, {bufnr}, {frontmatter})
590+
Save frontmatter to the given buffer.
591+
592+
Parameters ~
593+
{bufnr} `(integer|?)`
594+
{frontmatter} `(table|?)`
595+
596+
Return ~
597+
`(boolean)` updated True if the buffer lines were updated, false otherwise.
598+
570599
------------------------------------------------------------------------------
571600
*obsidian.Workspace*
572601
`Workspace`

0 commit comments

Comments
 (0)