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

Fixes parallelism action() typos #459

Merged
merged 1 commit into from
Dec 5, 2024
Merged

Fixes parallelism action() typos #459

merged 1 commit into from
Dec 5, 2024

Conversation

skrawcz
Copy link
Contributor

@skrawcz skrawcz commented Dec 5, 2024

The signature was not correct.

Changes

How I tested this

Notes

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.

Important

Fix incorrect method signature for action() in parallelism.rst by adding missing parameters state and inputs.

  • Documentation:
    • Fix incorrect method signature for action() in TestMultiplePromptsWithSubgraph, TestMultiplePrompts, and another class in parallelism.rst.
    • Add missing parameters state: State and inputs: Dict[str, Any] to action() method signature.

This description was created by Ellipsis for 89c2862. It will automatically update as commits are pushed.

The signature was not correct.
@skrawcz skrawcz merged commit 1075a1c into main Dec 5, 2024
11 checks passed
@skrawcz skrawcz deleted the fix_docs branch December 5, 2024 19:15
Copy link

@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 89c2862 in 23 seconds

More details
  • Looked at 31 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 3 drafted comments based on config settings.
1. docs/concepts/parallelism.rst:372
  • Draft comment:
    Consider using Union from typing for compatibility with Python versions before 3.10.
def action(self, state: State, inputs: Dict[str, Any]) -> Union[Action, Callable, RunnableGraph]:
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR correctly updates the method signature to include parameters that are likely required for the action method to function correctly. However, the return type hint should be updated to use the 'Union' from 'typing' for compatibility with Python versions before 3.10.
2. docs/concepts/parallelism.rst:478
  • Draft comment:
    Consider using Union from typing for compatibility with Python versions before 3.10.
def action(self, state: State, inputs: Dict[str, Any]) -> Union[Action, Callable, RunnableGraph]:
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR correctly updates the method signature to include parameters that are likely required for the action method to function correctly. However, the return type hint should be updated to use the 'Union' from 'typing' for compatibility with Python versions before 3.10.
3. docs/concepts/parallelism.rst:533
  • Draft comment:
    Consider using Union from typing for compatibility with Python versions before 3.10.
def action(self, state: State, inputs: Dict[str, Any]) -> Union[Action, Callable, RunnableGraph]:
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The PR correctly updates the method signature to include parameters that are likely required for the action method to function correctly. However, the return type hint should be updated to use the 'Union' from 'typing' for compatibility with Python versions before 3.10.

Workflow ID: wflow_Jn8plNTG20LsOJEI


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link

github-actions bot commented Dec 5, 2024

A preview of is uploaded and can be seen here:

https://burr.dagworks.io/pull/459

Changes may take a few minutes to propagate. Since this is a preview of production, content with draft: true will not be rendered. The source is here: https://github.com/DAGWorks-Inc/burr/tree/gh-pages/pull/459/

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.

1 participant