Skip to content

Commit

Permalink
docs: add missing argument and example for tp.file.move
Browse files Browse the repository at this point in the history
refs: #1136
  • Loading branch information
Zachatoo committed Oct 11, 2023
1 parent 743a170 commit 9b2d141
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/documentation.toml
Original file line number Diff line number Diff line change
Expand Up @@ -208,10 +208,15 @@ description = "Format for the date, refer to format reference."
name = "functions.move"
description = "Moves the file to the desired vault location."
definition = "tp.file.move(new_path: string, file_to_move?: TFile)"
example = "<% tp.file.move(\"/Notes/MyNote\") %>"

[[tp.file.functions.move.args]]
name = "new_path"
description = "The new vault relative path of the file, without the file extension. Note: the new path needs to include the folder and the filename, e.g. /Notes/MyNote"
description = "The new vault relative path of the file, without the file extension. Note: the new path needs to include the folder and the filename, e.g. `\"/Notes/MyNote\"`"

[[tp.file.functions.move.args]]
name = "file_to_move"
description = "The file to move, defaults to the current file."

[tp.file.functions.path]
name = "path"
Expand Down

0 comments on commit 9b2d141

Please sign in to comment.