Skip to content
This repository has been archived by the owner on Jul 19, 2024. It is now read-only.

Добавить документацию к функции #21

Open
Temmmmmo opened this issue Dec 7, 2023 · 0 comments
Open

Добавить документацию к функции #21

Temmmmmo opened this issue Dec 7, 2023 · 0 comments

Comments

@Temmmmmo
Copy link
Member

Temmmmmo commented Dec 7, 2023

Основная проблема

В файле с ручками, а точнее с одной ручкой app/routes/script_launch.py, есть метод run_script. Его документация написана на английском и при этом одна часть документации относится к самой работе метода, а вторая к его принимаемым параметрам.

Задача

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

1 participant