Skip to content

Commit

Permalink
More change WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
pp-mo committed Jan 13, 2025
1 parent a228c17 commit 900b5bb
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
17 changes: 12 additions & 5 deletions docs/userdocs/user_guide/data_objects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,8 @@ Or, likewise, to ***set*** values, one of
but **not** ``dataset.variables['x'].attributes['units'].value = "K"``


Component ordering
^^^^^^^^^^^^^^^^^^
Container ordering
------------------
The order of elements of a container is technically significant, and does constitute a
potential difference between datasets (or files).

Expand All @@ -193,9 +193,16 @@ while :meth:`ncdata.NameMap.add` adds the new components at the end.
The :func:`ncdata.utils.dataset_differences` utility provides various keywords allowing
you to ignore ordering in comparisons, when required.

Other :class:`~ncdata.NameMap` methods
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The :class:`~ncdata.NameMap` class also provides

Container methods
-----------------
The :class:`~ncdata.NameMap` class also provides a variety of manipulation methods,
both normal dictionary operations and some extra ones.

The most notable ones are : ``del``, ``pop``, ``add``, ``addall``, ``rename`` and of
course ``__setitem__`` .

See :ref:`common_operations` section.

.. _data-constructors:

Expand Down
4 changes: 3 additions & 1 deletion docs/userdocs/user_guide/general_topics.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _common_operations:

Common Operations
=================
A group of common operations are available on all the core component types,
Expand Down Expand Up @@ -98,7 +100,7 @@ Note : here, the variables were created before the dimensions
Equality Checks
---------------
We provide a simple ``==`` check for all the core objects but this can be very costly,
at least for variables, because it will check al the data (!).
at least for variables, because it will check all the data, even in lazy arrays (!).

You can use :func:`ncdata.utils.dataset_differences` for much more nuanced and controllable
checking.
Expand Down

0 comments on commit 900b5bb

Please sign in to comment.