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

Fix docstring inject #146

Merged
merged 2 commits into from
Apr 23, 2023
Merged

Fix docstring inject #146

merged 2 commits into from
Apr 23, 2023

Conversation

elijahbenizzy
Copy link
Collaborator

@elijahbenizzy elijahbenizzy commented Apr 23, 2023

https://hamilton-opensource.slack.com/archives/C03MANME6G5/p1682229443886529

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.

Copy link
Collaborator

@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.

need to rebase this PR I believe. Otherwise looks good.

Beforehand, we broke if there was a docstring in an inject decorated
function. This was due to having a placeholder function name, as it
delegated to `@parameterize`. The best fix would be to not have it
delegate (this is a bit of a hack), but for now we make it not break.
@elijahbenizzy elijahbenizzy merged commit bfc2300 into main Apr 23, 2023
@elijahbenizzy elijahbenizzy deleted the fix-docstring-inject branch April 23, 2023 20:46
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