-
-
Notifications
You must be signed in to change notification settings - Fork 81
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
Labels
help wanted
Требуется дополнительное внимание
Comments
Сюда же можно писать опечатки, ошибки, неточности, некорректность формата, предложения по поводу документации. |
Не UPD: Решено в #570 |
Ишус чутка устарел, 1 и 2 пункты думаю уже неактуальные |
Указан список идентификаторов треков, по факту только один yandex-music-api/yandex_music/client.py Line 540 in d844e47
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1. В старых местах документации используется такое:
Надо обновить до такого:
Обновить только в атрибутах, в аргументах должно быть без этого, но с optional
Это касается всех полей, которые являются объектами классов библиотеки, не смотря на опциональность в аргументах.
Опциональность в аргументах влияет на наличие optional.
2. Пересмотреть названия атрибутов и аргументов. Зарезервированные имена допускаются в атрибутах, но не в аргументах.
3. Пересмотреть блоки
Raise
в докстрингах. Была некорректная ссылка.4. Очень много
TODO
у полей, надо разобраться за что они отвечают и задокументировать.The text was updated successfully, but these errors were encountered: