Merge pull request #2 from RChloe/master

Add explicit returns to docs and link to models

Author: TJBIII

docs/index.rst

@@ -16,3 +16,4 @@ TekDrive Python SDK
    reference/search
    reference/trash
    reference/tree
+   reference/user

docs/reference/models/user.rst

@@ -10,11 +10,11 @@ Partial User
    :inherited-members:
    :exclude-members: parse
 
-.. _user:
+.. _drive_user:
 
-User
-----
+Drive User
+------------
 
-.. autoclass:: tekdrive.models.User
+.. autoclass:: tekdrive.models.DriveUser
    :inherited-members:
    :exclude-members: parse

docs/reference/user.rst

@@ -0,0 +1,8 @@
+.. _user:
+
+User
+----
+
+.. autoclass:: tekdrive.models.User
+   :inherited-members:
+   :exclude-members: parse

tekdrive/models/drive/file.py

@@ -163,6 +163,9 @@ def members(self) -> MembersList:
 
                 for member in file.members():
                     print(member.username)
+
+        Returns:
+            List [ :ref:`member` ]
         """
         route = Route("GET", ENDPOINTS["file_members"], file_id=self.id)
         members = self._tekdrive.request(route)
@@ -332,6 +335,8 @@ def add_member(
 
                 file_member = file.add_member(user_id="354bcafb-6c54-4a1f-9b94-a76f38b548e5", edit_access=True)
 
+        Returns:
+            :ref:`member`
         """
         data = dict(permissions=dict(read=True, edit=edit_access))
         if user_id:
@@ -379,6 +384,9 @@ def modify_member(self, user_id: str, edit_access: bool) -> Member:
 
                 updated_file_member = file.modify_member(user_id="354bcafb-6c54-4a1f-9b94-a76f38b548e5", edit_access=False)
 
+        Returns:
+            :ref:`member`
+
         """
         route = Route(
             "PUT", ENDPOINTS["file_member"], file_id=self.id, member_id=user_id

tekdrive/models/drive/folder.py

@@ -117,6 +117,9 @@ def children(self) -> List[Union[File, "Folder"]]:
 
                 for child in folder.children():
                     print(child.id)
+        
+        Returns:
+            List [ Union [:ref:`file` , :ref:`folder`] ]
         """
         if self._children is not None:
             return self._children
@@ -134,6 +137,9 @@ def members(self) -> List[Member]:
 
                 for member in folder.members():
                     print(member.username)
+
+        Returns:
+            List [ :ref:`member` ]
         """
         route = Route("GET", ENDPOINTS["folder_members"], folder_id=self.id)
         members = self._tekdrive.request(route)
@@ -228,6 +234,8 @@ def add_member(
 
                 folder_member = folder.add_member(user_id="354bcafb-6c54-4a1f-9b94-a76f38b548e5", edit_access=True)
 
+        Returns:
+            :ref:`member`
         """
         data = dict(permissions=dict(read=True, edit=edit_access))
         if user_id:
@@ -275,6 +283,8 @@ def modify_member(self, user_id: str, edit_access: bool) -> Member:
 
                 updated_folder_member = folder.modify_member(user_id="354bcafb-6c54-4a1f-9b94-a76f38b548e5", edit_access=False)
 
+        Returns: 
+            :ref:`member`
         """
         route = Route(
             "PUT", ENDPOINTS["folder_member"], folder_id=self.id, member_id=user_id

tekdrive/models/search.py

@@ -50,6 +50,9 @@ def files(
 
                 results = td.search.files(file_type="WFM", limit=50)
 
+        Returns:
+            Iterator [ :ref:`file` ]
+
         """
         return self.query(
             limit=limit,
@@ -91,6 +94,8 @@ def folders(
 
                 results = td.search.folders(name="team_", limit=10)
 
+        Returns:
+            Iterator [ :ref:`folder` ]
         """
         return self.query(
             limit=limit,
@@ -140,6 +145,8 @@ def query(
 
                 results = td.search.query(name="project1", include_folders=False)
 
+        Returns:
+            Iterator [ Union [ :ref:`file` , :ref:`folder` ] ]
         """
         if all(param is None for param in [name, file_type]):
             raise ClientException("Must supply `name`, `file_type`, or `upload_state`.")

tekdrive/models/tree.py

@@ -45,6 +45,9 @@ def get(
             Get tree for the ``SHARES`` silo, excluding files::
 
                 tree = td.tree.get(silo="SHARES", folders_only=True)
+
+        Returns:
+            :ref:`folder`
         """
 
         route = Route("GET", ENDPOINTS["tree"])

tekdrive/models/user.py

@@ -27,6 +27,9 @@ def me(self) -> DriveUser:
 
                 plan = td.user.me().plan
 
+        Returns: 
+            :ref:`drive_user`
+
         """
         route = Route("GET", ENDPOINTS["user"])
         return self._tekdrive.request(route)