Skip to content

Conversation

@bustosalex1
Copy link
Contributor

Just addressing 2 small issues I noticed in the Parallel Execution documentation. Thanks for working on this great project!

Changes

  • Fixed (what I presume) is a typo in the docs for Parallel Execution, as well as a link that was formatted for markdown instead of RST.

How I tested this

  • Built docs locally and verified updates.

Checklist

  • [ x] 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 d96500c in 1 minute and 0 seconds

More details
  • Looked at 22 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 6 drafted comments based on config settings.
1. docs/concepts/parallel-task.rst:105
  • Draft comment:
    Correct type hint for 'counts'. Changing return type from str to int now correctly reflects that the function returns the length of split string.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is purely informative, as it simply acknowledges a correct change without providing any actionable feedback or suggestions. It does not align with the rules provided, which prohibit purely informative comments.
2. docs/concepts/parallel-task.rst:138
  • Draft comment:
    Updated link formatting to RST style from markdown style. Ensures documentation renders correctly.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is purely informative, explaining a change from markdown to RST style for documentation purposes. It doesn't provide a suggestion, ask for confirmation, or highlight a potential issue. According to the rules, purely informative comments should be removed.
3. docs/concepts/parallel-task.rst:102
  • Draft comment:
    Good catch! Changing the return type of the counts function from str to int ensures that the type hint correctly reflects that len() returns an integer.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is purely informative, explaining the reason for a change in the return type of a function. It does not suggest any action or improvement, nor does it ask for confirmation or testing. According to the rules, purely informative comments should be removed.
4. docs/concepts/parallel-task.rst:135
  • Draft comment:
    The link formatting has been updated to use proper reStructuredText syntax. This fixes the markdown style link and will render correctly in the docs.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is purely informative and does not provide any actionable feedback or suggestions for improvement. It simply acknowledges a change that was made, which violates the rule against making purely informative comments.
5. docs/concepts/parallel-task.rst:137
  • Draft comment:
    Typo: In the sentence 'Another option is write a customer wrapper function that uses __set_state__ and __get_state__...', 'customer' should be replaced with 'custom'.
  • Reason this comment was not posted:
    Comment was on unchanged code.
6. docs/concepts/parallel-task.rst:64
  • Draft comment:
    Typographical issue: The sentence 'Note that the new executor is required to handle dynamic creation of nodes (E.G. using Parallelizable[] and Collect[].' is missing a closing parenthesis. Please add a ')' at the end of the parenthetical statement.
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.

Workflow ID: wflow_g24RwJq1NcEpfQAx


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

Copy link
Contributor

@skrawcz skrawcz left a comment

Choose a reason for hiding this comment

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

thank you!

@skrawcz skrawcz merged commit a14aefa into apache:main Mar 12, 2025
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