From 9b2d14172393183501bd87d1e023be9d0375dac6 Mon Sep 17 00:00:00 2001 From: Zachatoo Date: Tue, 10 Oct 2023 20:07:23 -0600 Subject: [PATCH] docs: add missing argument and example for tp.file.move refs: #1136 --- docs/documentation.toml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/documentation.toml b/docs/documentation.toml index b8c57d1e..f1cd41bc 100644 --- a/docs/documentation.toml +++ b/docs/documentation.toml @@ -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"