fix documentation

[rifcrat]

Изменил документацию

[github-actions]

💩 Code linting failed, use black and isort to fix it.

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
rating_api
__main__.py	4	4	0%	1–7
exceptions.py	43	7	84%	35–37, 48–50, 58
rating_api/models
base.py	64	4	94%	24–27
db.py	164	18	89%	115, 117, 119, 121, 132, 171, 189, 199, 213, 222–224, 257, 271–283
rating_api/routes
base.py	16	1	94%	41
comment.py	151	35	77%	65, 83, 132–133, 155–164, 176, 240–241, 243–244, 252–257, 266, 273–275, 299, 316, 346–357, 375
exc_handlers.py	32	3	91%	36, 43, 50
lecturer.py	109	9	92%	70–71, 81, 87–88, 220, 228, 248, 254
rating_api/schemas
base.py	12	4	67%	6–9
models.py	155	3	98%	189, 191, 201
rating_api/utils
mark.py	8	8	0%	1–20
TOTAL	792	96	88%

Summary

Tests	Skipped	Failures	Errors	Time
88	0 💤	0 ❌	0 🔥	25.784s ⏱️

[petrCher]

Надо делать инфу про raises то есть какие исключения в случае чего вылетают. и в целом иногда лучше прописывать задаваемые параметры, чтобы было понятнее в случае неочевидных названий/параметров

[petrCher]

А еще надо использовать форматирование black isort(сейчас вылетает ошибка в Python package / linting (pull_request))

[petrCher]

Еще справа сбоку есть панель, где ты ревью запросил у меня. там надо в development добавить задачу, которую выполняешь, чтобы после мерджа пр(пулл реквеста) задача автоматически закрылась

[petrCher]

Также, я очень надеюсь ты смог у себя локально запустить свагер и потыкать там все.
Рекомендую все вопросы по пр писать сюда комментом, а в тг просто писать что откомментил