From bf55b4b996b3c9b4f387faff45e9f7fd0e1ee75a Mon Sep 17 00:00:00 2001 From: tehkillerbee Date: Mon, 27 Nov 2023 15:58:36 +0100 Subject: [PATCH] Added descriptions to all parameters used for favorite tracks. Use underscore for parameter names. --- tidalapi/user.py | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/tidalapi/user.py b/tidalapi/user.py index a852de1..d6f75a4 100644 --- a/tidalapi/user.py +++ b/tidalapi/user.py @@ -340,16 +340,26 @@ def playlists( ), ) - def tracks(self, limit: Optional[int] = None, offset: int = 0, order: str = "NAME", orderDirection: str = "ASC") -> List["Track"]: + def tracks( + self, + limit: Optional[int] = None, + offset: int = 0, + order: str = "NAME", + order_direction: str = "ASC", + ) -> List["Track"]: """Get the users favorite tracks. + :param limit: Optional; The amount of items you want returned. + :param offset: The index of the first item you want included. + :param order: A :class:`str` describing the ordering type when returning the user favorite tracks. eg.: "NAME, "DATE" + :param order_direction: A :class:`str` describing the ordering direction when sorting by `order`. eg.: "ASC", "DESC" :return: A :class:`list` of :class:`~tidalapi.media.Track` objects containing all of the favorite tracks. """ params = { "limit": limit, "offset": offset, "order": order, - "orderDirection": orderDirection + "orderDirection": order_direction, } return cast(