pydata / pydata/xarray

Out of date docstring for concat_dim in open_mfdataset

Open
#3,158 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

topic-combine topic-documentation
Dominant language
Python
Stars
4.2k
Forks
1.4k
Avg merge
2d 15h
Merged PRs (30d)
14

Description

In the open_mfdataset docstring:

    concat_dim : str, or list of str, DataArray, Index or None, optional
        Dimensions to concatenate files along.  You only
        need to provide this argument if any of the dimensions along which you
        want to concatenate is not a dimension in the original datasets, e.g.,
        if you want to stack a collection of 2D arrays along a third dimension.
        ...

This is true for the default combine='_old_auto', but when using combine='nested' it is required while it is not used by combine='by_coords'. It would be clearer to make that distinction here.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Update the open_mfdataset docstring in xarray/backends/api.py, around the concat_dim section linked in the issue. Read how the documentation currently describes combine='_old_auto', combine='nested', and combine='by_coords', then revise the text to distinguish when concat_dim is required or unused. Done means the docstring accurately reflects all three combine modes.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.