amend pipe_input example in docstring#1239
Merged
elijahbenizzy merged 1 commit intoapache:mainfrom Nov 22, 2024
Merged
Conversation
Contributor
There was a problem hiding this comment.
👍 Looks good to me! Reviewed everything up to 24e5872 in 26 seconds
More details
- Looked at
13lines of code in1files - Skipped
0files when reviewing. - Skipped posting
2drafted comments based on config settings.
1. hamilton/function_modifiers/macros.py:848
- Draft comment:
The change in the docstring example is correct. The function now returns the sum ofp1,p2, andp3, which aligns with the function signature and expected behavior. - Reason this comment was not posted:
Confidence changes required:0%
The change in the docstring example is correct and aligns with the intended functionality of thepipe_inputdecorator. The example now correctly returns the sum ofp1,p2, andp3, which is consistent with the function signature and the expected behavior of thepipe_inputdecorator.
2. hamilton/function_modifiers/macros.py:850
- Draft comment:
Consider adding this example to the Sphinx documentation underdocs/to illustrate the use ofpipe_inputwith multiple parameter targets. - Reason this comment was not posted:
Confidence changes required:50%
The code is a documentation update, but it includes a code example that should be added to the Sphinx documentation.
Workflow ID: wflow_jXXxtyK78spo6yFF
You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
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
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.
Documentation example discontinuity fixed for
pipe_input.The example would have failed if executed.
Changes
fixed the docstring example
How I tested this
I did not test this
Checklist