Skip to content

docs: Improve subset() method documentation#633

Closed
RamiNoodle733 wants to merge 1 commit intojazzband:masterfrom
RamiNoodle733:improve-subset-docs
Closed

docs: Improve subset() method documentation#633
RamiNoodle733 wants to merge 1 commit intojazzband:masterfrom
RamiNoodle733:improve-subset-docs

Conversation

@RamiNoodle733
Copy link

Improves documentation for the Dataset.subset() method as requested in #366.

Changes

  • Added detailed docstring with parameter descriptions
  • Included usage examples for common use cases
  • Clarified row/column selection behavior

Fixes #366

- Add detailed parameter descriptions
- Add usage example
- Document requirement for headers to be set
- Document return value and exceptions

Fixes #366
@codecov
Copy link

codecov bot commented Feb 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.14%. Comparing base (7d6c58a) to head (9632f96).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #633   +/-   ##
=======================================
  Coverage   93.14%   93.14%           
=======================================
  Files          29       29           
  Lines        3226     3226           
=======================================
  Hits         3005     3005           
  Misses        221      221           

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

@RamiNoodle733 RamiNoodle733 closed this by deleting the head repository Feb 6, 2026
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.

Dataset.subset interface badly explained, works only if headers are set

1 participant