Vinay Sajip avatar Vinay Sajip committed ca96279 Draft

Routine update.

Comments (0)

Files changed (2)

docs/overview.rst

 has yet been made: to work with the project, you need to clone the source
 repository or download a tarball from it.
 
+Coverage results are available at:
+
+http://www.red-dove.com/distlib/coverage/
+
 The source repository for the project is on BitBucket:
 
 https://bitbucket.org/vinay.sajip/distlib/

docs/reference.rst

       Initialise an instance with the locator to be used for locating
       distributions.
 
-   .. method:: find(requirement)
+   .. method:: find(requirement, tests=False)
+
+      Find all the distributions needed to fulfill ``requirement``.
+
+      :param requirement: A string of the from ``name (version)`` where
+                          version can include an inequality constraint, or an
+                          instance of :class:`Distribution` (e.g. representing
+                          a distribution on the local hard disk).
+      :param tests: If ``True``, include requirements which are only needed for
+                    running tests. Otherwise, leave these out.
+      :returns: A 2-tuple. The first element is a set of :class:`Distribution`
+                instances. The second element is a set of problems encountered
+                during dependency resolution. Currently, if this set is non-
+                empty, it will contain 2-tuples whose first element is the
+                string 'unsatisfied' and whose second element is a requirement
+                which couldn't be satisified.
+
 
 Functions
 ^^^^^^^^^
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.