Removed unnecessary docs comments

Signed-off-by: Alexander Piskun <bigcat88@icloud.com>

Author: bigcat88

nc_py_api/_session.py

@@ -321,7 +321,6 @@ def _create_adapter(self, dav: bool = False) -> Client:
         )
 
     def _add_auth(self, request: Request):
-        # request.url.copy_add_param()
         request.headers.update({
             "AUTHORIZATION-APP-API": b64encode(f"{self._user}:{self.cfg.app_secret}".encode("UTF=8"))
         })

nc_py_api/user_status.py

@@ -121,11 +121,7 @@ def available(self) -> bool:
         return not check_capabilities("user_status.enabled", self._session.capabilities)
 
     def get_list(self, limit: typing.Optional[int] = None, offset: typing.Optional[int] = None) -> list[UserStatus]:
-        """Returns statuses for all users.
-
-        :param limit: limits the number of results.
-        :param offset: offset of results.
-        """
+        """Returns statuses for all users."""
         require_capabilities("user_status.enabled", self._session.capabilities)
         data = kwargs_to_params(["limit", "offset"], limit=limit, offset=offset)
         result = self._session.ocs("GET", f"{self._ep_base}/statuses", params=data)
@@ -137,10 +133,7 @@ def get_current(self) -> CurrentUserStatus:
         return CurrentUserStatus(self._session.ocs("GET", f"{self._ep_base}/user_status"))
 
     def get(self, user_id: str) -> typing.Optional[UserStatus]:
-        """Returns the user status for the specified user.
-
-        :param user_id: User ID for getting status.
-        """
+        """Returns the user status for the specified user."""
         require_capabilities("user_status.enabled", self._session.capabilities)
         try:
             return UserStatus(self._session.ocs("GET", f"{self._ep_base}/statuses/{user_id}"))
@@ -195,21 +188,15 @@ def set_status(self, message: typing.Optional[str] = None, clear_at: int = 0, st
         self._session.ocs("PUT", f"{self._ep_base}/user_status/message/custom", params=params)
 
     def get_backup_status(self, user_id: str = "") -> typing.Optional[UserStatus]:
-        """Get the backup status of the user if any.
-
-        :param user_id: User ID for getting status.
-        """
+        """Get the backup status of the user if any."""
         require_capabilities("user_status.enabled", self._session.capabilities)
         user_id = user_id if user_id else self._session.user
         if not user_id:
             raise ValueError("user_id can not be empty.")
         return self.get(f"_{user_id}")
 
     def restore_backup_status(self, status_id: str) -> typing.Optional[CurrentUserStatus]:
-        """Restores the backup state as current for the current user.
-
-        :param status_id: backup status ID.
-        """
+        """Restores the backup state as current for the current user."""
         require_capabilities("user_status.enabled", self._session.capabilities)
         require_capabilities("user_status.restore", self._session.capabilities)
         result = self._session.ocs("DELETE", f"{self._ep_base}/user_status/revert/{status_id}")

nc_py_api/users.py

@@ -170,21 +170,13 @@ def __init__(self, session: NcSessionBasic):
     def get_list(
         self, mask: typing.Optional[str] = "", limit: typing.Optional[int] = None, offset: typing.Optional[int] = None
     ) -> list[str]:
-        """Returns list of user IDs.
-
-        :param mask: user ID mask to apply.
-        :param limit: limits the number of results.
-        :param offset: offset of results.
-        """
+        """Returns list of user IDs."""
         data = kwargs_to_params(["search", "limit", "offset"], search=mask, limit=limit, offset=offset)
         response_data = self._session.ocs("GET", self._ep_base, params=data)
         return response_data["users"] if response_data else {}
 
     def get_user(self, user_id: str = "") -> UserInfo:
-        """Returns detailed user information.
-
-        :param user_id: the identifier of the user about which information is to be returned.
-        """
+        """Returns detailed user information."""
         return UserInfo(self._session.ocs("GET", f"{self._ep_base}/{user_id}" if user_id else "/ocs/v1.php/cloud/user"))
 
     def create(self, user_id: str, display_name: typing.Optional[str] = None, **kwargs) -> None:
@@ -216,31 +208,19 @@ def create(self, user_id: str, display_name: typing.Optional[str] = None, **kwar
         self._session.ocs("POST", self._ep_base, json=data)
 
     def delete(self, user_id: str) -> None:
-        """Deletes user from the Nextcloud server.
-
-        :param user_id: id of the user.
-        """
+        """Deletes user from the Nextcloud server."""
         self._session.ocs("DELETE", f"{self._ep_base}/{user_id}")
 
     def enable(self, user_id: str) -> None:
-        """Enables user on the Nextcloud server.
-
-        :param user_id: id of the user.
-        """
+        """Enables user on the Nextcloud server."""
         self._session.ocs("PUT", f"{self._ep_base}/{user_id}/enable")
 
     def disable(self, user_id: str) -> None:
-        """Disables user on the Nextcloud server.
-
-        :param user_id: id of the user.
-        """
+        """Disables user on the Nextcloud server."""
         self._session.ocs("PUT", f"{self._ep_base}/{user_id}/disable")
 
     def resend_welcome_email(self, user_id: str) -> None:
-        """Send welcome email for specified user again.
-
-        :param user_id: id of the user.
-        """
+        """Send welcome email for specified user again."""
         self._session.ocs("POST", f"{self._ep_base}/{user_id}/welcome")
 
     def editable_fields(self) -> list[str]:
@@ -257,35 +237,19 @@ def edit(self, user_id: str, **kwargs) -> None:
             self._session.ocs("PUT", f"{self._ep_base}/{user_id}", params={"key": k, "value": v})
 
     def add_to_group(self, user_id: str, group_id: str) -> None:
-        """Adds user to the group.
-
-        :param user_id: ID of the user.
-        :param group_id: the destination group to which add user to.
-        """
+        """Adds user to the group."""
         self._session.ocs("POST", f"{self._ep_base}/{user_id}/groups", params={"groupid": group_id})
 
     def remove_from_group(self, user_id: str, group_id: str) -> None:
-        """Removes user from the group.
-
-        :param user_id: ID of the user.
-        :param group_id: group from which remove user.
-        """
+        """Removes user from the group."""
         self._session.ocs("DELETE", f"{self._ep_base}/{user_id}/groups", params={"groupid": group_id})
 
     def promote_to_subadmin(self, user_id: str, group_id: str) -> None:
-        """Makes user admin of the group.
-
-        :param user_id: ID of the user.
-        :param group_id: group where user should become administrator.
-        """
+        """Makes user admin of the group."""
         self._session.ocs("POST", f"{self._ep_base}/{user_id}/subadmins", params={"groupid": group_id})
 
     def demote_from_subadmin(self, user_id: str, group_id: str) -> None:
-        """Removes user from the admin role of the group.
-
-        :param user_id: ID of the user.
-        :param group_id: group where user should be removed from administrators.
-        """
+        """Removes user from the admin role of the group."""
         self._session.ocs("DELETE", f"{self._ep_base}/{user_id}/subadmins", params={"groupid": group_id})
 
     def get_avatar(

nc_py_api/users_groups.py

@@ -62,67 +62,40 @@ def __init__(self, session: NcSessionBasic):
     def get_list(
         self, mask: typing.Optional[str] = None, limit: typing.Optional[int] = None, offset: typing.Optional[int] = None
     ) -> list[str]:
-        """Returns a list of user groups IDs.
-
-        :param mask: group ID mask to apply.
-        :param limit: limits the number of results.
-        :param offset: offset of results.
-        """
+        """Returns a list of user groups IDs."""
         data = kwargs_to_params(["search", "limit", "offset"], search=mask, limit=limit, offset=offset)
         response_data = self._session.ocs("GET", self._ep_base, params=data)
         return response_data["groups"] if response_data else []
 
     def get_details(
         self, mask: typing.Optional[str] = None, limit: typing.Optional[int] = None, offset: typing.Optional[int] = None
     ) -> list[GroupDetails]:
-        """Returns a list of user groups with detailed information.
-
-        :param mask: group ID mask to apply.
-        :param limit: limits the number of results.
-        :param offset: offset of results.
-        """
+        """Returns a list of user groups with detailed information."""
         data = kwargs_to_params(["search", "limit", "offset"], search=mask, limit=limit, offset=offset)
         response_data = self._session.ocs("GET", f"{self._ep_base}/details", params=data)
         return [GroupDetails(i) for i in response_data["groups"]] if response_data else []
 
     def create(self, group_id: str, display_name: typing.Optional[str] = None) -> None:
-        """Creates the users group.
-
-        :param group_id: the ID of group to be created.
-        :param display_name: display name for a created group.
-        """
+        """Creates the users group."""
         params = {"groupid": group_id}
         if display_name is not None:
             params["displayname"] = display_name
         self._session.ocs("POST", f"{self._ep_base}", params=params)
 
     def edit(self, group_id: str, display_name: str) -> None:
-        """Edits users group information.
-
-        :param group_id: the ID of group to edit info.
-        :param display_name: new group display name.
-        """
+        """Edits users group information."""
         params = {"key": "displayname", "value": display_name}
         self._session.ocs("PUT", f"{self._ep_base}/{group_id}", params=params)
 
     def delete(self, group_id: str) -> None:
-        """Removes the users group.
-
-        :param group_id: the ID of group to remove.
-        """
+        """Removes the users group."""
         self._session.ocs("DELETE", f"{self._ep_base}/{group_id}")
 
     def get_members(self, group_id: str) -> list[str]:
-        """Returns a list of group users.
-
-        :param group_id: Group ID to get the list of members.
-        """
+        """Returns a list of group users."""
         response_data = self._session.ocs("GET", f"{self._ep_base}/{group_id}")
         return response_data["users"] if response_data else {}
 
     def get_subadmins(self, group_id: str) -> list[str]:
-        """Returns list of users who is subadmins of the group.
-
-        :param group_id: group ID to get the list of subadmins.
-        """
+        """Returns list of users who is subadmins of the group."""
         return self._session.ocs("GET", f"{self._ep_base}/{group_id}/subadmins")