Merge pull request #212 from MarshalX/issue-59

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

ファイルの表示

@ -7,13 +7,45 @@ if TYPE_CHECKING:
class Genre(YandexMusicObject):
"""Класс, представляющий .
"""Класс, представляющий жанр музыки.
Attributes:
id (:obj:`str`): Уникальный идентификатор жанра.
weight (:obj:`int`): Вес TODO (возможно, чем выше показатель, тем больше нравится пользователю).
composer_top (:obj:`bool`): TODO.
title (:obj:`str`): Заголовок жанра.
titles (:obj:`dict`): Словарь заголовков на разных языках, где ключ - язык.
images (:obj:`yandex_music.Images`): Объект класса :class:`yandex_music.Images`, представляющий изображение
жанра.
show_in_menu (:obj:`bool`): Показывать в меню.
full_title (:obj:`str`): Полный заголовок.
url_part (:obj:`str`): Часть ссылки на жанр для открытия в браузере.
color (:obj:`str`): Цвет фона изображения.
radio_icon (:obj:`yandex_music.Icon`): Объект класса :class:`yandex_music.Images`, представляющий иконку радио
жанра.
sub_genres (:obj:`list` из :obj:`yandex_music.Genre`): Список объектов класса :class:`yandex_music.Genre`,
представляющие поджанры текущего жанра музыки.
hide_in_regions (:obj:`list`): В каких регионах скрывать жанр.
client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент
Yandex Music.
Args:
id_ (:obj:`str`): Уникальный идентификатор жанра.
weight (:obj:`int`): Вес TODO (возможно, чем выше показатель, тем больше нравится пользователю).
composer_top (:obj:`bool`): TODO.
title (:obj:`str`): Заголовок жанра.
titles (:obj:`dict`): Словарь заголовков на разных языках, где ключ - язык.
images (:obj:`yandex_music.Images`): Объект класса :class:`yandex_music.Images`, представляющий изображение
жанра.
show_in_menu (:obj:`bool`): Показывать в меню.
full_title (:obj:`str`, optional): Полный заголовок.
url_part (:obj:`str`, optional): Часть ссылки на жанр для открытия в браузере.
color (:obj:`str`, optional): Цвет фона изображения.
radio_icon (:obj:`yandex_music.Icon`, optional): Объект класса :class:`yandex_music.Images`, представляющий
иконку радио жанра.
sub_genres (:obj:`list` из :obj:`yandex_music.Genre`, optional): Список объектов класса
:class:`yandex_music.Genre`, представляющие поджанры текущего жанра музыки.
hide_in_regions (:obj:`list`, optional): В каких регионах скрывать жанр.
client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент
Yandex Music.
**kwargs: Произвольные ключевые аргументы полученные от API.