Documentation rendering bug - `set_options`

[ianhi]

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

[kmuehlbauer]

Did you try to use double quotes? There are double quotes used in other parts of that docstring.

[keewis]

for this to work we would need sphinx.ext.napoleon to support tuples, which even after changing in sphinx will take a while to get (some of our docs dependencies have upper bounds on the sphinx version). For now, I think we can work around this by replacing the default with optional and mentioning the defaults in the text.