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

MarshalX commented 4 years ago

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

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

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

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

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

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

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

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

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

MarshalX commented 4 years ago

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