-
Notifications
You must be signed in to change notification settings - Fork 59
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
vdk-meta-jobs: improve DAGs code documentation #1873
Conversation
Signed-off-by: Yoan Salambashev <[email protected]>
Signed-off-by: Yoan Salambashev <[email protected]>
for more information, see https://pre-commit.ci
projects/vdk-plugins/vdk-meta-jobs/src/vdk/plugin/meta_jobs/time_based_queue.py
Show resolved
Hide resolved
projects/vdk-plugins/vdk-meta-jobs/src/vdk/plugin/meta_jobs/plugin_entry.py
Outdated
Show resolved
Hide resolved
projects/vdk-plugins/vdk-meta-jobs/src/vdk/plugin/meta_jobs/plugin_entry.py
Outdated
Show resolved
Hide resolved
projects/vdk-plugins/vdk-meta-jobs/src/vdk/plugin/meta_jobs/plugin_entry.py
Outdated
Show resolved
Hide resolved
projects/vdk-plugins/vdk-meta-jobs/src/vdk/plugin/meta_jobs/api/meta_job.py
Outdated
Show resolved
Hide resolved
projects/vdk-plugins/vdk-meta-jobs/src/vdk/plugin/meta_jobs/api/meta_job.py
Show resolved
Hide resolved
projects/vdk-plugins/vdk-meta-jobs/src/vdk/plugin/meta_jobs/api/meta_job.py
Show resolved
Hide resolved
projects/vdk-plugins/vdk-meta-jobs/src/vdk/plugin/meta_jobs/meta_configuration.py
Show resolved
Hide resolved
Signed-off-by: Yoan Salambashev <[email protected]>
Signed-off-by: Yoan Salambashev <[email protected]>
Signed-off-by: Yoan Salambashev <[email protected]>
Signed-off-by: Yoan Salambashev <[email protected]>
for more information, see https://pre-commit.ci
Once #1831 is merged you will need to "cross port" your changes there. |
Yes! We discussed this with @gageorgiev and I will adapt this MR to the changes once the one you mentioned is merged. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think less is more, so I'm in favour of removing rather than cluttering with docs. If there is something unordinary that needs to be documented, we may keep the comment to help the reader focus and understand what's important.
Signed-off-by: Yoan Salambashev <[email protected]>
Signed-off-by: Yoan Salambashev <[email protected]>
What: Improve the DAGs code documentation by ensuring all fields and public methods have documentation. Add code docs where it was missing. Testing Done: not needed as only code docs were added Signed-off-by: Yoan Salambashev <[email protected]>
What:
Improve the DAGs code documentation by ensuring all fields and public methods have documentation.
Add code docs where it was missing.
Testing Done: not needed as only code docs were added
Signed-off-by: Yoan Salambashev [email protected]