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

vdk-meta-jobs: improve DAGs code documentation #1873

Merged
merged 17 commits into from
Apr 13, 2023

Conversation

yonitoo
Copy link
Contributor

@yonitoo yonitoo commented Apr 10, 2023

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 ysalambashev@vmware.com

Yoan Salambashev added 2 commits April 10, 2023 16:59
Signed-off-by: Yoan Salambashev <ysalambashev@vmware.com>
Signed-off-by: Yoan Salambashev <ysalambashev@vmware.com>
@antoniivanov
Copy link
Collaborator

Once #1831 is merged you will need to "cross port" your changes there.

@yonitoo
Copy link
Contributor Author

yonitoo commented Apr 12, 2023

Yes! We discussed this with @gageorgiev and I will adapt this MR to the changes once the one you mentioned is merged.

Copy link
Contributor

@ivakoleva ivakoleva left a 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.

@yonitoo yonitoo merged commit 9243ce6 into main Apr 13, 2023
3 of 4 checks passed
@yonitoo yonitoo deleted the person/ysalambashev/update-dags-code-docs branch April 13, 2023 09:26
mivanov1988 pushed a commit that referenced this pull request Apr 18, 2023
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 <ysalambashev@vmware.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants