Documentation rendering bug - `set_options`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
What is your issue?
The default value for netcdf_order in set options is not being properly rendered by sphinx:
https://docs.xarray.dev/en/stable/generated/xarray.set_options.html
I tried to get this to work by adding a colon and switch to a tuple. but neither, nor their combination fixed this.
Code defined here: https://github.com/pydata/xarray/blob/20d377347154412aed41697da23274ca48c0fd54/xarray/core/options.py#L263-L267
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with xarray/core/options.py at lines 263-267 and compare the set_options API page linked in the issue with the source definition. Check how the netcdf_order default is rendered by Sphinx, then verify that the generated documentation displays the intended default correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100