embetter docstring

This commit is contained in:
meejah 2020-06-13 17:22:17 -06:00
parent caf77be8ae
commit 939f60f620

View File

@ -226,11 +226,11 @@ class _FakeTahoeUriHandler(Resource, object):
def create_fake_tahoe_root():
"""
If you wish to pre-populate data into the fake Tahoe grid, retain
a reference to this root and pass it to
a reference to this root by creating it yourself and passing it to
`create_tahoe_treq_client`. For example::
root = create_fake_tahoe_root()
root.add_data(...)
cap_string = root.add_data(...)
client = create_tahoe_treq_client(root)
:returns: an IResource instance that will handle certain Tahoe URI