summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLance Bragstad <lbragstad@gmail.com>2019-06-03 16:12:35 +0000
committerLance Bragstad <lbragstad@gmail.com>2019-06-03 16:12:35 +0000
commitdf83ef50e6739a18625e4e8e36c251d1286c6328 (patch)
treecbb14f223af879e9af204c4e452dbc5e7cad0a25
parent6c6067ec3927d81241bd6281d9b3fb886d4f09e3 (diff)
downloadtestresources-git-df83ef50e6739a18625e4e8e36c251d1286c6328.tar.gz
Update method signature in README.rst
The TestResourceManager implementation of `make()` actually requires at least one argument, `dependency_resources`. The introductory documentation in README.rst builds out an example, but the method signature of `make()` doesn't include this required argument. This commit updates the documentation to inlucde the required argument to be consistent with the implementation. It also calls out the example in doc/ by referencing it with a link.
-rw-r--r--README.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index 9502911..bc0778a 100644
--- a/README.rst
+++ b/README.rst
@@ -143,7 +143,7 @@ For instance::
def clean(self, resource):
shutil.rmtree(resource)
- def make(self):
+ def make(self, dependency_resources):
return tempfile.mkdtemp()
def isDirty(self, resource):
@@ -169,10 +169,12 @@ returns None, the framework does *not* consider this an error: be sure to always
return a valid resource, or raise an error. Error handling hasn't been heavily
exercised, but any bugs in this area will be promptly dealt with.
-A sample TestResourceManager can be found in the doc/ folder.
+A sample_ TestResourceManager can be found in the doc/ folder.
See pydoc testresources.TestResourceManager for details.
+.. _sample: doc/example.py
+
testresources.GenericResource
-----------------------------