Docs updates; fixes #265

Author: technige

docs/source/types/graph.rst

@@ -4,11 +4,10 @@ Graph Data Types
 
 Cypher queries can return entire graph structures as well as individual property values.
 
-, The graph types model graph data returned from a Cypher query.
+The graph data types detailed here model graph data returned from a Cypher query.
 Graph values cannot be passed in as parameters as it would be unclear whether the entity was intended to be passed by reference or by value.
 The identity or properties of that entity should be passed explicitly instead.
 
-All graph values returned within a given :class:`.StatementResult` are contained within a :class:`.Graph` instance, accessible via :meth:`.StatementResult.graph`.
 The driver contains a corresponding class for each of the graph types that can be returned.
 
 =============  ======================
@@ -19,22 +18,149 @@ Relationship   :class:`.Relationship`
 Path           :class:`.Path`
 =============  ======================
 
-.. autoclass:: neo4j.types.graph.Graph
-   :members:
+.. class:: neo4j.types.graph.Graph
 
-.. autoclass:: neo4j.types.graph.Entity
-   :members:
+    A local, self-contained graph object that acts as a container for :class:`.Node` and :class:`.Relationship` instances.
+    This is typically obtained via the :meth:`.BoltStatementResult.graph` method.
 
-.. autoclass:: neo4j.types.graph.EntitySetView
-   :members:
+    .. autoattribute:: nodes
 
-.. autoclass:: neo4j.types.graph.Node
-   :members:
-   :inherited-members:
+    .. autoattribute:: relationships
 
-.. autoclass:: neo4j.types.graph.Relationship
-   :members:
-   :inherited-members:
+    .. automethod:: relationship_type
 
-.. autoclass:: neo4j.types.graph.Path
-   :members:
+
+.. class:: neo4j.types.graph.Node
+
+    .. describe:: node == other
+
+        Compares nodes for equality.
+
+    .. describe:: node != other
+
+        Compares nodes for inequality.
+
+    .. describe:: hash(node)
+
+        Computes the hash of a node.
+
+    .. describe:: len(node)
+
+        Returns the number of properties on a node.
+
+    .. describe:: iter(node)
+
+        Iterates through all properties on a node.
+
+    .. describe:: node[key]
+
+        Returns a node property by key.
+        Raises :exc:`KeyError` if the key does not exist.
+
+    .. describe:: key in node
+
+        Checks whether a property key exists for a given node.
+
+    .. autoattribute:: graph
+
+    .. autoattribute:: id
+
+    .. autoattribute:: labels
+
+    .. automethod:: get
+
+    .. automethod:: keys
+
+    .. automethod:: values
+
+    .. automethod:: items
+
+
+.. class:: neo4j.types.graph.Relationship
+
+    .. describe:: relationship == other
+
+        Compares relationships for equality.
+
+    .. describe:: relationship != other
+
+        Compares relationships for inequality.
+
+    .. describe:: hash(relationship)
+
+        Computes the hash of a relationship.
+
+    .. describe:: len(relationship)
+
+        Returns the number of properties on a relationship.
+
+    .. describe:: iter(relationship)
+
+        Iterates through all properties on a relationship.
+
+    .. describe:: relationship[key]
+
+        Returns a relationship property by key.
+        Raises :exc:`KeyError` if the key does not exist.
+
+    .. describe:: key in relationship
+
+        Checks whether a property key exists for a given relationship.
+
+    .. describe:: type(relationship)
+
+        Returns the type (class) of a relationship.
+        Relationship objects belong to a custom subtype based on the type name in the underlying database.
+
+    .. autoattribute:: graph
+
+    .. autoattribute:: id
+
+    .. autoattribute:: nodes
+
+    .. autoattribute:: start_node
+
+    .. autoattribute:: end_node
+
+    .. autoattribute:: type
+
+    .. automethod:: get
+
+    .. automethod:: keys
+
+    .. automethod:: values
+
+    .. automethod:: items
+
+
+.. class:: neo4j.types.graph.Path
+
+    .. describe:: path == other
+
+        Compares paths for equality.
+
+    .. describe:: path != other
+
+        Compares paths for inequality.
+
+    .. describe:: hash(path)
+
+        Computes the hash of a path.
+
+    .. describe:: len(path)
+
+        Returns the number of relationships in a path.
+
+    .. describe:: iter(path)
+
+        Iterates through all the relationships in a path.
+
+    .. autoattribute:: graph
+
+    .. autoattribute:: nodes
+
+    .. autoattribute:: start_node
+
+    .. autoattribute:: end_node
+
+    .. autoattribute:: relationships

neo4j/types/graph.py

@@ -49,15 +49,13 @@ def __init__(self):
 
     @property
     def nodes(self):
-        """ Access an :class:`.EntitySetView` of the nodes in this
-        graph.
+        """ Access a set view of the nodes in this graph.
         """
         return self._node_set_view
 
     @property
     def relationships(self):
-        """ Access an :class:`.EntitySetView` of the relationships in
-        this graph.
+        """ Access a set view of the relationships in this graph.
         """
         return self._relationship_set_view
 
@@ -201,6 +199,8 @@ def __repr__(self):
 
     @property
     def labels(self):
+        """ The set of labels attached to this node.
+        """
         return frozenset(self._labels)
 
 
@@ -224,18 +224,27 @@ def __repr__(self):
 
     @property
     def nodes(self):
+        """ The pair of nodes which this relationship connects.
+        """
         return self._start_node, self._end_node
 
     @property
     def start_node(self):
+        """ The start node of this relationship.
+        """
         return self._start_node
 
     @property
     def end_node(self):
+        """ The end node of this relationship.
+        """
         return self._end_node
 
     @property
     def type(self):
+        """ The type name of this relationship.
+        This is functionally equivalent to ``type(relationship).__name__``.
+        """
         return type(self).__name__
 
     @property
@@ -294,22 +303,32 @@ def __iter__(self):
 
     @property
     def graph(self):
+        """ The :class:`.Graph` to which this path belongs.
+        """
         return self._nodes[0].graph
 
     @property
     def nodes(self):
+        """ The sequence of :class:`.Node` objects in this path.
+        """
         return self._nodes
 
     @property
     def start_node(self):
+        """ The first :class:`.Node` in this path.
+        """
         return self._nodes[0]
 
     @property
     def end_node(self):
+        """ The last :class:`.Node` in this path.
+        """
         return self._nodes[-1]
 
     @property
     def relationships(self):
+        """ The sequence of :class:`.Relationship` objects in this path.
+        """
         return self._relationships
 
     @property