Skip to content

Commit 3c934e2

Browse files
committed
separate user models for explicit reference
1 parent 221cc32 commit 3c934e2

File tree

4 files changed

+16
-4
lines changed

4 files changed

+16
-4
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ TekDrive Python SDK
1616
reference/search
1717
reference/trash
1818
reference/tree
19+
reference/user

docs/reference/models/user.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Partial User
1010
:inherited-members:
1111
:exclude-members: parse
1212

13-
.. _user:
13+
.. _drive_user:
1414

15-
User
16-
----
15+
Drive User
16+
------------
1717

18-
.. autoclass:: tekdrive.models.User
18+
.. autoclass:: tekdrive.models.DriveUser
1919
:inherited-members:
2020
:exclude-members: parse

docs/reference/user.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. _user:
2+
3+
User
4+
----
5+
6+
.. autoclass:: tekdrive.models.User
7+
:inherited-members:
8+
:exclude-members: parse

tekdrive/models/user.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ def me(self) -> DriveUser:
2727
2828
plan = td.user.me().plan
2929
30+
Returns:
31+
:ref:`drive_user`
32+
3033
"""
3134
route = Route("GET", ENDPOINTS["user"])
3235
return self._tekdrive.request(route)

0 commit comments

Comments
 (0)