doc string changes

Author: vaibhavatlan

pyatlan/client/group.py

@@ -144,13 +144,13 @@ def get_all(
         columns: Optional[List[str]] = None,
     ) -> GroupResponse:
         """
-        Retrieve all groups defined in Atlan.
+        Retrieve a GroupResponse object containing a list of all groups defined in Atlan.
 
         :param limit: maximum number of results to be returned
         :param offset: starting point for the list of groups when paging
         :param sort: property by which to sort the results, by default : name
         :param columns: provides columns projection support for groups endpoint
-        :returns: a list of all the groups in Atlan
+        :returns: a GroupResponse object with all groups based on the parameters; results are iterable.
         """
         response: GroupResponse = self.get(
             offset=offset, limit=limit, sort=sort, columns=columns
@@ -165,15 +165,15 @@ def get_by_name(
         offset: int = 0,
     ) -> Optional[GroupResponse]:
         """
-        Retrieve all groups with a name that contains the provided string.
+        Retrieves a GroupResponse object containing a list of groups that match the specified string.
         (This could include a complete group name, in which case there should be at most
         a single item in the returned list, or could be a partial group name to retrieve
         all groups with that naming convention.)
 
         :param alias: name (as it appears in the UI) on which to filter the groups
         :param limit: maximum number of groups to retrieve
         :param offset: starting point for the list of groups when paging
-        :returns: all groups whose name (in the UI) contains the provided string
+        :returns: a GroupResponse object containing a list of groups whose UI names include the given string; the results are iterable.
         """
         response: GroupResponse = self.get(
             offset=offset,

pyatlan/client/user.py

@@ -55,7 +55,7 @@ def create(
         :param users: the details of the new users
         :param return_info: whether to return the details of created users, defaults to `False`
         :raises AtlanError: on any API communication issue
-        :returns: the list of details of created users if `return_info` is `True`, otherwise `None`
+        :returns: a UserResponse object which contains the list of details of created users if `return_info` is `True`, otherwise `None`
         """
         from pyatlan.client.atlan import AtlanClient
 
@@ -203,12 +203,12 @@ def get_all(
         sort: Optional[str] = "username",
     ) -> UserResponse:
         """
-        Retrieve all users defined in Atlan.
+        Retrieve a UserResponse object containing a list of all users defined in Atlan.
 
         :param limit: maximum number of users to retrieve
         :param offset: starting point for the list of users when paging
         :param sort: property by which to sort the results, by default : `username`
-        :returns: a list of all the users in Atlan
+        :returns: a UserResponse object with all users based on the parameters; results are iterable.
         """
         response: UserResponse = self.get(offset=offset, limit=limit, sort=sort)
         return response
@@ -221,7 +221,7 @@ def get_by_email(
         offset: int = 0,
     ) -> Optional[UserResponse]:
         """
-        Retrieves all users with email addresses that contain the provided email.
+        Retrieves a UserResponse object containing a list of users with email addresses that contain the provided email.
         (This could include a complete email address, in which case there should be at
         most a single item in the returned list, or could be a partial email address
         such as "@example.com" to retrieve all users with that domain in their email
@@ -230,7 +230,7 @@ def get_by_email(
         :param email: on which to filter the users
         :param limit: maximum number of users to retrieve
         :param offset: starting point for the list of users when pagin
-        :returns: all users whose email addresses contain the provided string
+        :returns: a UserResponse object containing a list of users whose email addresses contain the provided string
         """
         response: UserResponse = self.get(
             offset=offset,
@@ -247,12 +247,12 @@ def get_by_emails(
         offset: int = 0,
     ) -> Optional[UserResponse]:
         """
-        Retrieves all users with email addresses that match the provided list of emails.
+        Retrieves a UserResponse object containing a list of users with email addresses that match the provided list of emails.
 
         :param emails: list of email addresses to filter the users
         :param limit: maximum number of users to retrieve
         :param offset: starting point for the list of users when paginating
-        :returns: list of users whose email addresses match the provided list
+        :returns: a UserResponse object containing a list of users whose email addresses match the provided list
         """
         email_filter = '{"email":{"$in":' + dumps(emails or [""]) + "}}"
         response: UserResponse = self.get(
@@ -283,12 +283,12 @@ def get_by_usernames(
         self, usernames: List[str], limit: int = 5, offset: int = 0
     ) -> Optional[UserResponse]:
         """
-        Retrieves users based on their usernames.
+        Retrieves a UserResponse object containing a list of users based on their usernames.
 
         :param usernames: the list of usernames by which to find the users
         :param limit: maximum number of users to retrieve
         :param offset: starting point for the list of users when paginating
-        :returns: the users with the specified usernames
+        :returns: a UserResponse object containing list of users with the specified usernames
         """
         username_filter = '{"username":{"$in":' + dumps(usernames or [""]) + "}}"
         response: UserResponse = self.get(

pyatlan/client/workflow.py

@@ -169,14 +169,14 @@ def find_runs_by_status_and_time_range(
         size: int = 100,
     ) -> WorkflowSearchResponse:
         """
-        Find workflow runs based on their status and time range.
+        Retrieves a WorkflowSearchResponse object containing workflow runs based on their status and time range.
 
         :param status: list of the workflow statuses to filter
         :param started_at: (optional) lower bound on 'status.startedAt' (e.g 'now-2h')
         :param finished_at: (optional) lower bound on 'status.finishedAt' (e.g 'now-1h')
         :param from_:(optional) starting index of the search results (default: `0`).
         :param size: (optional) maximum number of search results to return (default: `100`).
-        :returns: list of workflows matching the filters
+        :returns: a WorkflowSearchResponse object containing a list of workflows matching the filters
         :raises ValidationError: if inputs are invalid
         :raises AtlanError: on any API communication issue
         """