Skip to content

Commit

Permalink
Small doc fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
dotsdl committed Mar 23, 2016
1 parent 4dce6fa commit c46aa01
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
10 changes: 6 additions & 4 deletions docs/api_treants.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
Treants
=======
Treants are the core units of functionality of ``datreant``. They function as
specially marked directories with distinguishing characteristics. They designed
to be subclassed, with their functionality extendable with attachable Limbs.
specially marked directories with distinguishing characteristics. They are
designed to be subclassed, with their functionality extendable with attachable
Limbs.

The components documented here are those included within ``datreant.core``.

Expand Down Expand Up @@ -51,8 +52,9 @@ member locations as a persistent Bundle within its state file.

Members
```````
The class :class:`datreant.core.limbs.MemberBundle` is the interface used
by a Group to manage its members.
The class :class:`datreant.core.limbs.MemberBundle` is the interface used by a
Group to manage its members. Its API matches that of
:class:`datreant.core.Bundle`.

.. autoclass:: datreant.core.limbs.MemberBundle
:members:
Expand Down
8 changes: 4 additions & 4 deletions docs/bundles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ See the :func:`datreant.core.discover` API reference for more details.

Basic member selection
======================
All the same selection patterns that work for Views (see :ref:`Views_selecting`).
This includes indexing with integers::
All the same selection patterns that work for Views (see :ref:`Views_selecting`)
work for Bundles. This includes indexing with integers::

>>> b = dtr.discover()
>>> b[1]
Expand Down Expand Up @@ -226,7 +226,7 @@ view of the categories with keys present in every member Treant::
'type': ['evergreen', 'deciduous', 'deciduous', 'deciduous'],
'bark': ['fibrous', 'smooth', 'mossy', 'mossy']})>

We see that here, the values are lists, which each member of the list giving
We see that here, the values are lists, with each element of the list giving
the value for each member, in member order. This is how categories behave when
accessing from Bundles, since each member may have a different value for a
given key.
Expand All @@ -244,7 +244,7 @@ categories with each key present among at least one member with ::

Note that for members that lack a given key, the value returned in the
corresponding list is ``None``. Since ``None`` is not a valid value for a
category, this unambibuously marks the key as being absent for these members.
category, this unambiguously marks the key as being absent for these members.

Likewise we have ::

Expand Down
2 changes: 1 addition & 1 deletion docs/groups.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ are stored within the Group's state file. Obtaining subsets of the
MemberBundle, such as by slicing, indexing, filtering on tags, etc., will
always yield a Bundle::

>>>> g.members[2:]
>>> g.members[2:]
<Bundle([<Treant: 'oak'>, <Treant: 'elm'>])>

.. note:: Members are generated from their state files on disk upon access.
Expand Down

0 comments on commit c46aa01

Please sign in to comment.