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:

xarray/xarray/core/options.py

Lines 263 to 267 in 20d3773

	netcdf_engine_order : sequence, default ['netcdf4', 'h5netcdf', 'scipy']
	Preference order of backend engines to use when reading or writing
	netCDF files with ``open_dataset()`` and ``to_netcdf()`` if ``engine``
	is not explicitly specified. May be any permutation or subset of
	``['netcdf4', 'h5netcdf', 'scipy']``.

[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.