Skip to content

Commit 8073a7f

Browse files
authored
add set_options link to FAQ on metadata (#6056)
* link to xr.set_options in reference to "global flag" * syntax fix * switch to sphinx :py:func: anchor reference * xarray, not xr, in internal ref
1 parent a923833 commit 8073a7f

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

doc/getting-started-guide/faq.rst

+5-6
Original file line numberDiff line numberDiff line change
@@ -140,12 +140,11 @@ conventions`_. (An exception is serialization to and from netCDF files.)
140140

141141
An implication of this choice is that we do not propagate ``attrs`` through
142142
most operations unless explicitly flagged (some methods have a ``keep_attrs``
143-
option, and there is a global flag for setting this to be always True or
144-
False). Similarly, xarray does not check for conflicts between ``attrs`` when
145-
combining arrays and datasets, unless explicitly requested with the option
146-
``compat='identical'``. The guiding principle is that metadata should not be
147-
allowed to get in the way.
148-
143+
option, and there is a global flag, accessible with :py:func:`xarray.set_options`,
144+
for setting this to be always True or False). Similarly, xarray does not check
145+
for conflicts between ``attrs`` when combining arrays and datasets, unless
146+
explicitly requested with the option ``compat='identical'``. The guiding
147+
principle is that metadata should not be allowed to get in the way.
149148

150149
What other netCDF related Python libraries should I know about?
151150
---------------------------------------------------------------

0 commit comments

Comments
 (0)