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.

Sign up for GitHub

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

Jump to bottom

Add docstrings #60

Open

7 tasks

macpijan opened this issue Sep 3, 2024 · 0 comments

Assignees

Labels

good first issue

Milestone

Contributor

macpijan commented Sep 3, 2024 •

edited

Loading

Code should be better documented.

We can split the effort into documenting following modules:

Some documentation has been added here: https://github.com/Dasharo/osfv-scripts/pull/78/files
There is no specific format requirement set in stone yet. We can propose one here.

Hint: once we define a format, LLM can be a huge help to generate the docstrings based on code.

macpijan mentioned this issue

Add checkin-my subcommand for snipeit #58

Merged

macpijan added the good first issue label

macpijan added this to the v0.6.0 milestone

BeataZdunczyk assigned JakubRed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment