Adds more docs to the pytest example code#487
Merged
Conversation
Contributor
There was a problem hiding this comment.
👍 Looks good to me! Reviewed everything up to a74e101 in 12 seconds
More details
- Looked at
153lines of code in3files - Skipped
0files when reviewing. - Skipped posting
3drafted comments based on config settings.
1. examples/pytest/some_actions.py:135
- Draft comment:
Consider adding descriptions for each parameter in the docstring to improve clarity and completeness. - Reason this comment was not posted:
Confidence changes required:50%
The PR adds documentation to the code, which is generally good. However, there are some areas where the documentation could be improved for clarity and completeness.
2. examples/pytest/some_actions.py:160
- Draft comment:
Consider adding descriptions for each parameter in the docstring to improve clarity and completeness. - Reason this comment was not posted:
Confidence changes required:50%
The PR adds documentation to the code, which is generally good. However, there are some areas where the documentation could be improved for clarity and completeness.
3. examples/pytest/some_actions.py:107
- Draft comment:
Consider adding descriptions for each parameter in the docstring to improve clarity and completeness. - Reason this comment was not posted:
Confidence changes required:50%
The PR adds documentation to the code, which is generally good. However, there are some areas where the documentation could be improved for clarity and completeness.
Workflow ID: wflow_a1MJgDGMzEjSW96q
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
|
A preview of is uploaded and can be seen here: ✨ https://burr.dagworks.io/pull/487 ✨ Changes may take a few minutes to propagate. Since this is a preview of production, content with |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds more docs to pytest example,.
Changes
How I tested this
Notes
Checklist
Important
Enhances documentation and adds docstrings to
examples/pytestcode for better clarity and understanding.some_actions.pyandtest_some_actions.py.README.mdwith additional notes and explanations on usingpytestandBurrfor testing.some_actions.pyto explain the purpose and functionality of actions and classes.test_some_actions.pyto clarify test cases and their expected outcomes.This description was created by
for a74e101. It will automatically update as commits are pushed.