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

Clarify documentation of DataChunkIterator #813

Merged
merged 5 commits into from
Jan 13, 2023
Merged

Clarify documentation of DataChunkIterator #813

merged 5 commits into from
Jan 13, 2023

Conversation

oruebel
Copy link
Contributor

@oruebel oruebel commented Jan 11, 2023

Motivation

Fix #623 Clarify the expected chunk shape behavior for DataChunkIterator.

How to test the behavior?

This PR only updates docstrings

Checklist

  • Did you update CHANGELOG.md with your changes?
  • Have you checked our Contributing document?
  • Have you ensured the PR clearly describes the problem and the solution?
  • Is your contribution compliant with our coding style? This can be checked running flake8 from the source directory.
  • Have you checked to ensure that there aren't other open Pull Requests for the same change?
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.

@oruebel oruebel requested a review from rly January 11, 2023 00:00
@oruebel oruebel added topic: docs Issues related to documentation priority: low alternative solution already working and/or relevant to only specific user(s) labels Jan 11, 2023
@oruebel oruebel added this to the Next Release milestone Jan 11, 2023
@codecov
Copy link

codecov bot commented Jan 11, 2023

Codecov Report

Base: 87.77% // Head: 87.77% // No change to project coverage 👍

Coverage data is based on head (4f856f3) compared to base (95f1965).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #813   +/-   ##
=======================================
  Coverage   87.77%   87.77%           
=======================================
  Files          44       44           
  Lines        8936     8936           
  Branches     2061     2061           
=======================================
  Hits         7844     7844           
  Misses        777      777           
  Partials      315      315           
Impacted Files Coverage Δ
src/hdmf/data_utils.py 90.29% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@oruebel oruebel merged commit ad55477 into dev Jan 13, 2023
@oruebel oruebel deleted the enh/dci_docs branch January 13, 2023 00:05
@rly rly removed this from the 3.14.0 milestone Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: low alternative solution already working and/or relevant to only specific user(s) topic: docs Issues related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DataChunkIterator clarify iteration behavior
2 participants