From 85e4ee5b54c334d4104e6c3b2f3fda11cd9b2dd6 Mon Sep 17 00:00:00 2001 From: Xavier Claessens Date: Sat, 21 Oct 2023 09:47:39 -0400 Subject: File: Add full_path() method This is needed now that str.format() is not allowing it any more. It is also more consistent with other objects that have that method as well, such as build targets. Fixes: #12406 --- docs/yaml/objects/file.yaml | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'docs/yaml') diff --git a/docs/yaml/objects/file.yaml b/docs/yaml/objects/file.yaml index 6aa0b85ce..5d2ad3053 100644 --- a/docs/yaml/objects/file.yaml +++ b/docs/yaml/objects/file.yaml @@ -1,3 +1,13 @@ name: file long_name: File -description: Opaque object that stores the path to an existing file +description: Object that stores the path to an existing file + +methods: +- name: full_path + returns: str + since: 1.4.0 + description: | + Returns a full path pointing to the file. This is useful for printing the + path with e.g [[message]] function for debugging purpose. + **NOTE:** In most cases using the object itself will do the same job + as this and will also allow Meson to setup dependencies correctly. -- cgit v1.2.3