From d221787541940dbe0e70f24cd8def42188666e8f Mon Sep 17 00:00:00 2001 From: meejah Date: Sat, 13 Jun 2020 02:03:19 -0600 Subject: [PATCH] better docstring --- src/allmydata/testing/web.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/allmydata/testing/web.py b/src/allmydata/testing/web.py index ef7cd5bed..5f011f8b1 100644 --- a/src/allmydata/testing/web.py +++ b/src/allmydata/testing/web.py @@ -225,6 +225,14 @@ 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 + `create_tahoe_treq_client`. For example:: + + root = create_fake_tahoe_root() + root.add_data(...) + client = create_tahoe_treq_client(root) + :returns: an IResource instance that will handle certain Tahoe URI endpoints similar to a real Tahoe server. """