Skip to content

amend pipe_input example in docstring #1239

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

Merged
merged 1 commit into from
Nov 22, 2024
Merged

Conversation

sT0v
Copy link
Contributor

@sT0v sT0v commented Nov 22, 2024

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

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Reviewed everything up to 24e5872 in 26 seconds

More details
  • Looked at 13 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted 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 of p1, p2, and p3, 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 the pipe_input decorator. The example now correctly returns the sum of p1, p2, and p3, which is consistent with the function signature and the expected behavior of the pipe_input decorator.
2. hamilton/function_modifiers/macros.py:850
  • Draft comment:
    Consider adding this example to the Sphinx documentation under docs/ to illustrate the use of pipe_input with 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.

Copy link
Contributor

@elijahbenizzy elijahbenizzy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@elijahbenizzy elijahbenizzy merged commit 0db9a70 into apache:main Nov 22, 2024
19 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants