Skip to content

Commit

Permalink
Document stubs and .fetch() function
Browse files Browse the repository at this point in the history
  • Loading branch information
bartek committed Apr 27, 2015
1 parent 7cf4417 commit 25bef91
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ data. The fields are parsed and converted to python objects as specified in the
resource class.

A nested resource will only be instantiated when its corresponding attribute is
accessed in the parent resource.
accessed in the parent resource. These resources may be returned as a ``stub``,
and upon access of an attribute not present, will internally call ``.fetch()``
on the resource to populate it.

A field pointing to the URL for a collection of a child resources will hold a
``Query`` object for that resource. As for nested resources, it will only be
Expand Down

0 comments on commit 25bef91

Please sign in to comment.