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

Add docstrings #60

Open
7 tasks
macpijan opened this issue Sep 3, 2024 · 2 comments
Open
7 tasks

Add docstrings #60

macpijan opened this issue Sep 3, 2024 · 2 comments
Assignees
Labels
good first issue Good for newcomers
Milestone

Comments

@macpijan
Copy link
Contributor

macpijan commented Sep 3, 2024

Code should be better documented.

We can split the effort into documenting following modules:

  • CLI
  • libs/rte*
  • libs/snipeit_api
  • libs/sonoff_api
  • libs/utils
  • libs/zabbix
  • rf/*

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.

@JakubRed
Copy link
Contributor

Regarding the question in JIRZe:

If this standard is ok, then I will apply it to all the methods.

Untill now, I tried to create manually. Searching for smaller parts of the code. (I'm not sure what is the company policy on using LLM and such). If it is allowed then it would considerably speed up execution of the task.

@JakubRed JakubRed reopened this Feb 24, 2025
@JakubRed
Copy link
Contributor

PR#109 I added some inline documentation in the files listed above.
I mostly focused on short summaries.
There is still a lot to be added but due to the sheer number of methods that is all I was able to do in given time frame.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants