Skip to content

add f string to print gap info #554

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.

Sign up for GitHub

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

Jump to bottom
Merged
d-chambers merged 3 commits into from
Sep 26, 2025
Merged

add f string to print gap info #554

d-chambers merged 3 commits into from
Sep 26, 2025

Conversation

@d-chambers
Copy link
Contributor

@d-chambers d-chambers commented Sep 24, 2025 •
edited by coderabbitai bot
Loading

Description

There was a small issue in #538 in that the warning didn't use an f string but references an instance variable to print information.

Checklist

I have (if applicable):

  • referenced the GitHub issue this PR closes.
  • documented the new feature with docstrings or appropriate doc page.
  • included a test. See testing guidelines.
  • your name has been added to the contributors page (docs/contributors.md).
  • added the "ready_for_review" tag once the PR is ready to be reviewed.

Summary by CodeRabbit

  • Bug Fixes
    • Improved warning message clarity when determining continuity groups: messages now include the dimension name and the actual numeric tolerance value instead of a placeholder. This is a display-only change; grouping behavior and logic remain unchanged.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 24, 2025 •
edited
Loading

Walkthrough

Updated an error message in dascore/utils/chunk.py: _get_continuity_group_number now builds the message with an f-string that interpolates the dimension name and numeric tolerance. No control-flow or logic changes; warning behavior unchanged.

Changes

Cohort / File(s) Summary of Changes
Error message formatting
dascore/utils/chunk.py		 Replaced a multi-line message containing the literal {self._tolerance} with an f-string that injects self._name and self._tolerance into _get_continuity_group_number; functional behavior unchanged.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly describes the primary change by stating that an f-string was added to print gap information, which directly matches the code update in the changeset. It is concise, specific, and clearly conveys the main purpose of the PR.
Description Check ✅ Passed The description uses the repository’s template with a clear “## Description” section that explains the issue and references the related PR, and it includes the “## Checklist” section matching the template structure. The necessary context about the bug and the fix is present and the template headings are correctly applied.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-gap-warning
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cee9438 and d5bcf5f.

📒 Files selected for processing (1)
  • dascore/utils/chunk.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (17)
  • GitHub Check: test_code (windows-latest, 3.12)
  • GitHub Check: test_code (macos-latest, 3.12)
  • GitHub Check: test_code (windows-latest, 3.13)
  • GitHub Check: test_code (windows-latest, 3.11)
  • GitHub Check: test_code (windows-latest, 3.10)
  • GitHub Check: test_code (macos-latest, 3.13)
  • GitHub Check: test_code (ubuntu-latest, 3.10)
  • GitHub Check: test_code (ubuntu-latest, 3.13)
  • GitHub Check: test_code (ubuntu-latest, 3.11)
  • GitHub Check: test_code (ubuntu-latest, 3.12)
  • GitHub Check: test_code (macos-latest, 3.11)
  • GitHub Check: test_code_min_deps (windows-latest, 3.12)
  • GitHub Check: test_code_min_deps (windows-latest, 3.13)
  • GitHub Check: test_code_min_deps (macos-latest, 3.12)
  • GitHub Check: test_code_min_deps (macos-latest, 3.13)
  • GitHub Check: test_code_min_deps (ubuntu-latest, 3.12)
  • GitHub Check: test_code_min_deps (ubuntu-latest, 3.13)
🔇 Additional comments (1)
dascore/utils/chunk.py (1)

206-210: Interpolated warning looks good.

Thanks for wiring the warning through an f-string—dimension name and tolerance now surface correctly. 👍

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]
coderabbitai bot reviewed Sep 24, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
dascore/utils/chunk.py (1)

206-209: Optional: include dimension context and concise numeric formatting.

Minor polish to make the message clearer and avoid verbose floats; consider referencing the sampling dimension and using general format.

Apply this diff:

-                f"still considered contiguous as a tolerance of {self._tolerance} "
+                f"still considered contiguous as a tolerance of {self._tolerance:g} * {self._name}_step "
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b115a76 and cee9438.

📒 Files selected for processing (1)
  • dascore/utils/chunk.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (17)
  • GitHub Check: test_code (ubuntu-latest, 3.10)
  • GitHub Check: test_code (macos-latest, 3.12)
  • GitHub Check: test_code (windows-latest, 3.10)
  • GitHub Check: test_code (ubuntu-latest, 3.12)
  • GitHub Check: test_code (ubuntu-latest, 3.11)
  • GitHub Check: test_code (windows-latest, 3.12)
  • GitHub Check: test_code (windows-latest, 3.11)
  • GitHub Check: test_code (windows-latest, 3.13)
  • GitHub Check: test_code (macos-latest, 3.13)
  • GitHub Check: test_code (ubuntu-latest, 3.13)
  • GitHub Check: test_code (macos-latest, 3.11)
  • GitHub Check: test_code_min_deps (macos-latest, 3.13)
  • GitHub Check: test_code_min_deps (ubuntu-latest, 3.13)
  • GitHub Check: test_code_min_deps (macos-latest, 3.12)
  • GitHub Check: test_code_min_deps (windows-latest, 3.12)
  • GitHub Check: test_code_min_deps (windows-latest, 3.13)
  • GitHub Check: test_code_min_deps (ubuntu-latest, 3.12)
🔇 Additional comments (1)
dascore/utils/chunk.py (1)

206-209: LGTM: warning now interpolates the actual tolerance.

Using f-strings fixes the stale placeholder and makes the warning actionable. The adjacent f-strings concatenate correctly.

@codecov
Copy link

codecov bot commented Sep 24, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.92%. Comparing base (018d807) to head (07a909c).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master     #554   +/-   ##
=======================================
  Coverage   99.92%   99.92%           
=======================================
  Files         126      126           
  Lines       10472    10472           
=======================================
  Hits        10464    10464           
  Misses          8        8
Flag Coverage Δ
unittests 99.92% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@codspeed-hq
Copy link

codspeed-hq bot commented Sep 26, 2025

CodSpeed Performance Report

Merging #554 will not alter performance

Comparing fix-gap-warning (07a909c) with master (018d807)

Summary

✅ 49 untouched

@d-chambers d-chambers merged commit bfc966f into master Sep 26, 2025
24 checks passed
@d-chambers d-chambers deleted the fix-gap-warning branch October 2, 2025 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@d-chambers