better documentation

This commit is contained in:
2017-02-07 11:21:23 +01:00
parent 27ced50728
commit c27b8692b8

View File

@@ -17,7 +17,7 @@ Usage
``get`` retrieves data, ``update`` transforms it based on its form, and ``set`` ``get`` retrieves data, ``update`` transforms it based on its form, and ``set``
transforms it by simply resetting. Transformations can be applied in place or transforms it by simply resetting. Transformations can be applied in place or
on a copy. The default is in place, because copying is expensive. If you want a on a copy. The default is in place, because copying is expensive. If you want a
copy of the data, set the keyword argument ``in_place`` to ``True``. copy of the data, set the keyword argument ``in_place`` to ``False``.
It uses a query "language" not unlike CSS, albeit much, much simpler. The only It uses a query "language" not unlike CSS, albeit much, much simpler. The only
two entities in this "language" are IDs—denoted by ``#``—and Classes—denoted by two entities in this "language" are IDs—denoted by ``#``—and Classes—denoted by