filetree lookup: document RETURN value state (#11997)

* Clarify 'state' parameter description in filetree.py

Updated the description for the 'state' parameter to clarify entry types and their meanings.

* Apply suggestion from felixfontein related to description

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Santosh Mahale
2026-05-07 11:08:20 +05:30
committed by GitHub
parent 4aa38ea336
commit 240ff65311

View File

@@ -88,8 +88,12 @@ _raw:
description: The permissions the resulting file or directory. description: The permissions the resulting file or directory.
type: str type: str
state: state:
description: TODO. description:
- Type of the resulting file or directory.
- V(directory) for a directory, V(file) for a regular file, V(link) for a symbolic link.
- Other file types are skipped and not returned.
type: str type: str
choices: [directory, file, link]
owner: owner:
description: Name of the user that owns the file/directory. description: Name of the user that owns the file/directory.
type: raw type: raw