Skip to content

Fixes resolve decorator docs #1270

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 3 commits into from
Jan 13, 2025
Merged

Fixes resolve decorator docs #1270

merged 3 commits into from
Jan 13, 2025

Conversation

MG-MW
Copy link
Contributor

@MG-MW MG-MW commented Jan 13, 2025

Fixed errors in docs of resolve decorator

Changes

  • ordered list in markdown needs double linebreak in some cases
  • fixed error in __init__ argument name

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 7241d61 in 31 seconds

More details
  • Looked at 30 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. hamilton/function_modifiers/delayed.py:121
  • Draft comment:
    The instance variable self.until should be renamed to self.when to match the parameter name and avoid confusion.
  • Reason this comment was not posted:
    Comment was not on a valid diff hunk.
2. hamilton/function_modifiers/delayed.py:121
  • Draft comment:
    The variable self.until should be renamed to self.when to maintain consistency with the parameter name and improve code readability.
  • Reason this comment was not posted:
    Marked as duplicate.

Workflow ID: wflow_cHirEgdP7vglsdtz


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.

thanks @MG-MW !

@skrawcz skrawcz merged commit 7f4bc66 into apache:main Jan 13, 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