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

Update docstring and prevent name collisions #9078

Merged
merged 3 commits into from
Mar 20, 2025
Merged

Conversation

sjrl
Copy link
Contributor

@sjrl sjrl commented Mar 20, 2025

Related Issues

  • fixes #issue-number

Proposed Changes:

  • Update formatting of the docstring
  • Pass the correct prepared data to the tracer (following what's done for the normal Pipeline)
  • Get rid of "shadows from outer scope" warnings, where we reuse the same variable names in an outer scope within a function that has the potential to cause unexpected behavior. It looks in this case it was fine, but best to avoid.

How did you test it?

Notes for the reviewer

Checklist

  • I have read the contributors guidelines and the code of conduct
  • I have updated the related issue with new insights and changes
  • I added unit tests and updated the docstrings
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I documented my code
  • I ran pre-commit hooks and fixed any issue

@github-actions github-actions bot added topic:core type:documentation Improvements on the docs labels Mar 20, 2025
@coveralls
Copy link
Collaborator

coveralls commented Mar 20, 2025

Pull Request Test Coverage Report for Build 13967377660

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 90.113%

Totals Coverage Status
Change from base Build 13964579599: 0.0%
Covered Lines: 9816
Relevant Lines: 10893

💛 - Coveralls

@sjrl sjrl added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Mar 20, 2025
@sjrl sjrl marked this pull request as ready for review March 20, 2025 10:41
@sjrl sjrl requested a review from a team as a code owner March 20, 2025 10:41
@sjrl sjrl requested review from Amnah199 and removed request for a team March 20, 2025 10:41
@davidsbatista
Copy link
Contributor

I see often"shadows from outer scope" in other sections of the codebase - not top priority, but if we plan to change them all, maybe we can add a rule to ruff to detect it.

I investigated it, it seems it's still not supported but listed as something to be added as redefined-outer-name / W0621
check: astral-sh/ruff#970

we can add it to pylint though.

Copy link
Contributor

@davidsbatista davidsbatista 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!

@sjrl sjrl merged commit f3fc689 into main Mar 20, 2025
27 of 28 checks passed
@sjrl sjrl deleted the update-async-pipe-docstrings branch March 20, 2025 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore-for-release-notes PRs with this flag won't be included in the release notes. topic:core type:documentation Improvements on the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants