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

Parallelism Documentation Improvements #493

Merged
merged 4 commits into from
Jan 2, 2025
Merged

Conversation

mdrideout
Copy link
Contributor

@mdrideout mdrideout commented Jan 1, 2025

Documentation updates only.

Changes

  • RunnableGraph halt_after example updated to List[str] to match RunnableGraph create() method: return RunnableGraph(graph=graph, entrypoint=action.name, halt_after=[action.name])
  • Imports corrected / added to clarify where classes used in the example are declared

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

Update parallelism.rst to correct RunnableGraph example and imports for clarity.

  • Documentation:
    • Update RunnableGraph halt_after example to List[str] to match create() method.
    • Add missing import for RunnableGraph in parallelism.rst.
    • Correct imports to clarify class declarations in examples.

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

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 22f6f9f in 8 seconds

More details
  • Looked at 30 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 0 drafted comments based on config settings.

Workflow ID: wflow_3ToGeuFVk5q2zb4d


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

@skrawcz skrawcz merged commit 386336e into DAGWorks-Inc:main Jan 2, 2025
10 of 11 checks passed
@skrawcz
Copy link
Contributor

skrawcz commented Jan 2, 2025

Thanks @mdrideout !

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