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

Analyze the possibilities of automatic collection of product documentation #59

Open
Vl-Tershch opened this issue Dec 9, 2024 · 0 comments
Assignees
Labels
Repo Working with the design or configuration of the repository

Comments

@Vl-Tershch
Copy link
Collaborator

Vl-Tershch commented Dec 9, 2024

Задача: Проанализировать возможности автоматического сбора документации продукта.
Результатом является выбор, а впоследствии и реализация качественной документации программного продукта. На данный момент кажется, что варианта два - автособирать документацию через docstrings, либо описывать вручную. Сейчас генерация документации происходит по docstrings, однако она выполняется лишь частично.


The result is the selection and subsequently the implementation of high-quality documentation of the software product. At the moment, it seems that there are two options - to automatically collect documentation through docstrings, or to describe it manually. Currently, documentation is generated using docstrings, but it is only partially performed.

@Vl-Tershch Vl-Tershch added the Repo Working with the design or configuration of the repository label Dec 9, 2024
@Vl-Tershch Vl-Tershch self-assigned this Dec 9, 2024
@Vl-Tershch Vl-Tershch changed the title Проанализировать возможности автоматического сбора документации продукта Analyze the possibilities of automatic collection of product documentation Dec 10, 2024
@Vl-Tershch Vl-Tershch added this to the Edulytica_2024_2025 milestone Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Repo Working with the design or configuration of the repository
Projects
None yet
Development

No branches or pull requests

1 participant