Vinay Sajip avatar Vinay Sajip committed ed1fc51

Documentation update for DependencyFinder.find.

Comments (0)

Files changed (1)

docs/reference.rst

                 string 'unsatisfied' and whose second element is a requirement
                 which couldn't be satisified.
 
+                In the set of :class:`Distribution` instances returned, some
+                attributes will be set:
+
+                * The instance representing the passed-in ``requirement`` will
+                  have the :attr:`requested` attribute set to ``True``.
+                * All requirements which are not installation requirements (in
+                  other words, are needed only for build and test) will have
+                  the :attr:`build_time_dependency` attribute set to ``True``.
+
 
 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.