[PR #11997/240ff653 backport][stable-12] filetree lookup: document RETURN value state (#12010)

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



---------


(cherry picked from commit 240ff65311)

Co-authored-by: Santosh Mahale <santoshmahale7676@gmail.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot]
2026-05-07 21:58:55 +02:00
committed by GitHub
parent 7400d367a0
commit 5c8d0feb45

View File

@@ -88,8 +88,12 @@ _raw:
description: The permissions the resulting file or directory.
type: str
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
choices: [directory, file, link]
owner:
description: Name of the user that owns the file/directory.
type: raw