Skip to content

Commit e688dcc

Browse files
authored
document the reason for requiring force_ndarray_like (#59)
* document the reason for requiring force_ndarray_like * update the changelog entry for a previous PR * add a entry to whats-new.rst [skip-ci]
1 parent 8071527 commit e688dcc

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

docs/creation.rst

+3
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,9 @@ or overwrite the default registry:
111111
To properly work with ``xarray``, the ``force_ndarray_like`` or
112112
``force_ndarray`` options have to be enabled on the custom registry.
113113

114+
Without it, python scalars wrapped by :py:class:`pint.Quantity` may raise errors or
115+
have their units stripped.
116+
114117
Saving with units
115118
-----------------
116119
In order to not lose the units when saving to disk, we first have to call the

docs/whats-new.rst

+4-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@ What's new
55
------------------
66
- rewrite :py:meth:`Dataset.pint.quantify` and :py:meth:`DataArray.pint.quantify`,
77
to use pint's `parse_units` instead of `parse_expression` (:pull:`40`)
8-
- refactor the internal conversion functions (:pull:``)
8+
- refactor the internal conversion functions (:pull:`56`)
9+
- allow converting indexes (except :py:class:`pandas.MultiIndex`) (:pull:`56`)
10+
- document the reason for requiring the ``force_ndarray_like`` or ``force_ndarray``
11+
options on unit registries (:pull:`59`)
912

1013
v0.1 (October 26 2020)
1114
----------------------

0 commit comments

Comments
 (0)