Skip to content

update nested describe docstring for error raise #330

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 1 commit into from
Aug 15, 2025

Conversation

Graciaaa3
Copy link
Collaborator

Change Description

Adding the Raises section to the NestedFrame.describe docstring. The code explicitly raise ValueError for the case where no statistics can be generated from the columns. There will be a combined error message given.

  • My PR includes a link to the issue that I am addressing

Code Quality

  • I have read the Contribution Guide
  • My code follows the code style of this project
  • My code builds (or compiles) cleanly without any errors or warnings
  • My code contains relevant comments and necessary documentation

Project-Specific Pull Request Checklists

Documentation Change Checklist

Copy link

codecov bot commented Aug 15, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@6158e29). Learn more about missing BASE report.
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #330   +/-   ##
=======================================
  Coverage        ?   98.10%           
=======================================
  Files           ?       18           
  Lines           ?     1742           
  Branches        ?        0           
=======================================
  Hits            ?     1709           
  Misses          ?       33           
  Partials        ?        0           

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

Copy link

Before [6158e29] After [ab052ef] Ratio Benchmark (Parameter)
41.2±1ms 43.5±0.8ms 1.06 benchmarks.ReassignHalfOfNestedSeries.time_run
2.87±0.01s 2.92±0.04s 1.02 benchmarks.ReadFewColumnsHTTPS.time_run
250M 250M 1 benchmarks.AssignSingleDfToNestedSeries.peakmem_run
10.3±0.07ms 10.2±0.02ms 1 benchmarks.NestedFrameQuery.time_run
1.20±0.01ms 1.20±0.01ms 1 benchmarks.NestedFrameReduce.time_run
177M 176M 1 benchmarks.ReadFewColumnsHTTPS.peakmem_run
270M 270M 1 benchmarks.ReassignHalfOfNestedSeries.peakmem_run
31.8±0.2ms 31.5±0.7ms 0.99 benchmarks.AssignSingleDfToNestedSeries.time_run
136M 135M 0.99 benchmarks.CountNestedBy.peakmem_run
103M 102M 0.99 benchmarks.NestedFrameAddNested.peakmem_run

Click here to view all benchmarks.

Copy link
Contributor

@gitosaurus gitosaurus left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Collaborator

@dougbrn dougbrn left a comment

Choose a reason for hiding this comment

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

Nice!

@Graciaaa3 Graciaaa3 marked this pull request as ready for review August 15, 2025 22:58
@Graciaaa3 Graciaaa3 merged commit 46acb8e into main Aug 15, 2025
11 checks passed
@Graciaaa3 Graciaaa3 deleted the nested_describe_docstring branch August 15, 2025 22:59
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.

3 participants