docs

cjw296 · Nov 1, 2011 · 35d21f6 · 35d21f6
1 parent 69c0b8d
commit 35d21f6
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/docs/description.txt b/docs/description.txt
@@ -2,7 +2,7 @@
 Nose Fixes
 ============
 
-A plugin that changes `nose <>`__ to behave better.
+A plugin that changes `nose <http://readthedocs.org/docs/nose/>`__ to behave better.
 Hopefully, these changes will make their way back into nose...
 
 See the documentation for more details.
diff --git a/docs/installation.txt b/docs/installation.txt
@@ -7,7 +7,7 @@ install it is::
   easy_install nose-fixes
 
 Or, if you're using `zc.buildout`, just specify ``nose-fixes`` as a
-required egg.
+required egg in the part(s) where you use `nose`.
 
 .. topic:: Python version requirements
 

diff --git a/docs/use.txt b/docs/use.txt
@@ -1,4 +1,15 @@
 Use
 ===
 
-XXX
+This plugin is enabled by default and will make `nose` respect modules
+that contain unit tests but define a function that returns the suite
+containing those tests rather than expecting the test runner to
+collect them directly.
+
+The name of this function is expected to be ``test_suite`` by default,
+if you require a different name to be used, please invoke nose as
+follows::
+
+  $ nosetests --test-suite-func=your_func_name
+
+