[Doc] Add documentation for DGLGraph.adj_sparse (dmlc#3096)

Co-authored-by: Minjie Wang <[email protected]>
lizeyan · Jul 7, 2021 · 751685a · 751685a
1 parent 188152b
commit 751685a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/docs/source/api/python/dgl.DGLGraph.rst b/docs/source/api/python/dgl.DGLGraph.rst
@@ -143,6 +143,7 @@ Methods for getting the adjacency and the incidence matrix of the graph.
     :toctree: ../../generated/
 
     DGLGraph.adj
+    DGLGraph.adj_sparse
     DGLGraph.adjacency_matrix
     DGLGraph.inc
     DGLGraph.incidence_matrix

diff --git a/python/dgl/heterograph.py b/python/dgl/heterograph.py
@@ -3619,7 +3619,9 @@ def adj_sparse(self, fmt, etype=None):
         --------
         >>> g = dgl.graph(([0, 1, 2], [1, 2, 3]))
         >>> g.adj_sparse('coo')
+        (tensor([0, 1, 2]), tensor([1, 2, 3]))
         >>> g.adj_sparse('csr')
+        (tensor([0, 1, 2, 3, 3]), tensor([1, 2, 3]), tensor([0, 1, 2]))
         """
         etid = self.get_etype_id(etype)
         if fmt == 'csc':