timmartin avatar timmartin committed 5b94aee

Expanded the docstring of gen_with_app to explain how it differs from with_app

Comments (0)

Files changed (1)

 def gen_with_app(*args, **kwargs):
     """
     Make a TestApp with args and kwargs, pass it to the test and clean up
-    properly.
+    properly. The wrapped function is assumed to be a generator and the
+    wrapper function is itself a generator that will iterate over the
+    values of the wrapped function and yield them.
     """
     def generator(func):
         @wraps(func)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.