Merge pull request #270 from MarshalX/issue-40

Документация класса Chart
このコミットが含まれているのは:
Il'ya 2020-03-22 05:21:43 +03:00 committed by GitHub
コミット 86e73b31b7
この署名に対応する既知のキーがデータベースに存在しません
GPGキーID: 4AEE18F83AFDEB23
1個のファイルの変更16行の追加3行の削除

ファイルの表示

@ -7,12 +7,25 @@ if TYPE_CHECKING:
class Chart(YandexMusicObject):
"""Класс, представляющий .
"""Класс, представляющий элемент чарта.
Note:
Смещение - это количество позиций, на которые трек поднялся или опустился в чарте.
Attributes:
position (:obj:`int`): Позиция.
progress (:obj:`str`): TODO.
listeners (:obj:`int`): Количество слушателей.
shift (:obj:`int`): Смещение.
track_id (:obj:`yandex_music.TrackId` | :obj:`None`): Уникальный идентификатор трека.
client (:obj:`yandex_music.Client`): Клиент Yandex Music.
Args:
position (:obj:`int`): Позиция.
progress (:obj:`str`): TODO.
listeners (:obj:`int`): Количество слушателей.
shift (:obj:`int`): Смещение.
track_id (:obj:`yandex_music.TrackId`, optional): Уникальный идентификатор трека.
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
**kwargs: Произвольные ключевые аргументы полученные от API.
"""
@ -44,7 +57,7 @@ class Chart(YandexMusicObject):
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
Returns:
:obj:`yandex_music.Chart`: TODO.
:obj:`yandex_music.Chart`: Элемент чарта.
"""
if not data:
return None
@ -64,7 +77,7 @@ class Chart(YandexMusicObject):
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
Returns:
:obj:`list` из :obj:`yandex_music.Chart`: TODO.
:obj:`list` из :obj:`yandex_music.Chart`: Чарт.
"""
if not data:
return []