Skip to content

Commit 902f4c4

Browse files
committed
fix: remove 'return_extended_graph' param from doc of Graph.layout_sugiyama()
1 parent c6cab4f commit 902f4c4

File tree

1 file changed

+0
-10
lines changed

1 file changed

+0
-10
lines changed

src/igraph/layout.py

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -671,16 +671,6 @@ def _layout_sugiyama(
671671
@param maxiter: maximum number of iterations to take in the crossing
672672
reduction step. Increase this if you feel that you are getting too many
673673
edge crossings.
674-
@param return_extended_graph: specifies that the extended graph with the
675-
added dummy vertices should also be returned. When this is C{True}, the
676-
result will be a tuple containing the layout and the extended graph. The
677-
first |V| nodes of the extended graph will correspond to the nodes of the
678-
original graph, the remaining ones are dummy nodes. Plotting the extended
679-
graph with the returned layout and hidden dummy nodes will produce a layout
680-
that is similar to the original graph, but with the added edge bends.
681-
The extended graph also contains an edge attribute called C{_original_eid}
682-
which specifies the ID of the edge in the original graph from which the
683-
edge of the extended graph was created.
684674
@return: the calculated layout and an additional list of matrices where the
685675
i-th matrix contains the control points of edge I{i} in the original graph
686676
(or an empty matrix if no control points are needed on the edge)

0 commit comments

Comments
 (0)