Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Пересмотреть документацию, внести правки #285

Open
MarshalX opened this issue Mar 22, 2020 · 4 comments
Labels
help wanted Требуется дополнительное внимание

Comments

@MarshalX
Copy link
Owner

MarshalX commented Mar 22, 2020

1. В старых местах документации используется такое:

price (:obj:`yandex_music.Price`): Цена.

Надо обновить до такого:

price (:obj:`yandex_music.Price` | :obj:`None`): Цена.

Обновить только в атрибутах, в аргументах должно быть без этого, но с optional
Это касается всех полей, которые являются объектами классов библиотеки, не смотря на опциональность в аргументах.

Опциональность в аргументах влияет на наличие optional.

2. Пересмотреть названия атрибутов и аргументов. Зарезервированные имена допускаются в атрибутах, но не в аргументах.

3. Пересмотреть блоки Raise в докстрингах. Была некорректная ссылка.

4. Очень много TODO у полей, надо разобраться за что они отвечают и задокументировать.

@MarshalX MarshalX added this to the Production/Stable milestone Mar 25, 2020
@MarshalX MarshalX pinned this issue Jun 7, 2020
@MarshalX
Copy link
Owner Author

MarshalX commented Jun 7, 2020

Сюда же можно писать опечатки, ошибки, неточности, некорректность формата, предложения по поводу документации.

@MarshalX MarshalX added the help wanted Требуется дополнительное внимание label Feb 2, 2021
@MarshalX MarshalX removed this from the Production/Stable milestone Feb 2, 2021
@glebliutsko
Copy link
Contributor

glebliutsko commented Nov 14, 2022

https://github.com/MarshalX/yandex-music-api/blob/main/yandex_music/album/track_position.py#L14

Не None, а Note

UPD: Решено в #570

@MarshalX
Copy link
Owner Author

Ишус чутка устарел, 1 и 2 пункты думаю уже неактуальные

@pank-su
Copy link

pank-su commented Jan 13, 2024

Указан список идентификаторов треков, по факту только один

track_id (:obj:`str` | :obj:`list` из :obj:`str`): Уникальный идентификатор трека или треков.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Требуется дополнительное внимание
Projects
None yet
Development

No branches or pull requests

3 participants