Skip to content

Update docs to reflect open_mfdataset default chunk behaviour #10567

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jemmajeffree
Copy link
Contributor

Looking at #5704 and #9038 (and various other issues that reference these), it seems like there's no easy solution and the current open_mfdataset chunk default is going to stay for a while. i.e. chunks=None as a kwarg to open_mfdataset is overwritten with chunks={} before calling open_dataset, so the default chunks are disk chunks not single-file chunks.

open_kwargs = dict(engine=engine, chunks=chunks or {}, **kwargs)

In which case, we should probably update the docs to reflect this current behaviour.

Copy link

welcome bot commented Jul 25, 2025

Thank you for opening this pull request! It may take us a few days to respond here, so thank you for being patient.
If you have questions, some answers may be found in our contributing guidelines.

@jemmajeffree
Copy link
Contributor Author

@dcherian would you mind taking a quick look at this for me?
It's unclear to me while some of the tests are failing, given the only thing I changed was a docstring

@keewis
Copy link
Collaborator

keewis commented Aug 5, 2025

I would expect the numba CI failure to either be unrelated or just flaky (and we don't have to care about the PR labeler here). I've restarted the CI, let's see if that changes things.

Edit: all CI passes!

@jemmajeffree
Copy link
Contributor Author

Thanks! Anything else I should do here, or am I just waiting for someone to check the docstring update is correct and merge?

@keewis keewis requested a review from dcherian August 6, 2025 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants