Add some docs for the DepcheckCompositeDB class.

svn path=/main/trunk/; revision=9785

diff --git a/pym/_emerge/__init__.py b/pym/_emerge/__init__.py
index 5d89a4c0951871d117a7248581bf91eee56a94f0..291df19fd0cc19dd0640c50b74a36e10f489fdef 100644 (file)
--- a/pym/_emerge/__init__.py
+++ b/pym/_emerge/__init__.py
@@ -1412,6 +1412,13 @@ def show_invalid_depstring_notice(parent_node, depstring, error_msg):
        f.end_paragraph(1)
 
 class DepcheckCompositeDB(object):
+       """
+       A dbapi-like interface that is optimized for use in dep_check() calls.
+       This is built on top of the existing depgraph package selection logic.
+       Some packages that have been added to the graph may be masked from this
+       view in order to control the atom preference selection that occurs via
+       dep_check().
+       """
        def __init__(self, depgraph, root):
                self._depgraph = depgraph
                self._root = root