pydata / pydata/xarray

List supported options for `backend_kwargs` in `open_dataset`

Open
#4,189 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

We should list supported options for backend_kwargs in the docstring for open_datasetand possibly in io.rst

xref #4187

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

Start with the open_dataset docstring and the io.rst documentation mentioned in the issue. Determine which backend_kwargs options are supported, document them in the appropriate location, and verify that the resulting documentation clearly lists the available options.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.