Skip to content

Commit 3fff399

Browse files
SDK-350 clarify CloudFSFolderFindingHelper.owner expects UserAccount
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 57faabe commit 3fff399

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

cterasdk/core/types.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,13 @@
88

99

1010
CloudFSFolderFindingHelper = namedtuple('CloudFSFolderFindingHelper', ('name', 'owner'))
11-
CloudFSFolderFindingHelper.__doc__ = 'Tuple holding the name and owner couple to search for folders'
11+
CloudFSFolderFindingHelper.__doc__ = 'Tuple holding the folder name and owner (UserAccount) to search for cloud drive folders'
1212
CloudFSFolderFindingHelper.name.__doc__ = 'The name of the CloudFS folder'
13-
CloudFSFolderFindingHelper.owner.__doc__ = 'The name of the owner of the CloudFS folder'
14-
13+
CloudFSFolderFindingHelper.owner.__doc__ = (
14+
'The owner of the CloudFS folder (:class:`cterasdk.core.types.UserAccount`).'
15+
' Use UserAccount (display_name) for local users,'
16+
' or UserAccount (name, domain) for domain users.'
17+
)
1518

1619
PlatformVersion = namedtuple('PlatformVersion', ('name', 'version'))
1720
PlatformVersion.__doc__ = 'Tuple holding the platform name and version'

0 commit comments

Comments
 (0)