summaryrefslogtreecommitdiff
path: root/networkx/relabel.py
diff options
context:
space:
mode:
authorLewis Robbins <24735903+lewisrobbins@users.noreply.github.com>2018-02-03 05:19:26 +0000
committerDan Schult <dschult@colgate.edu>2018-02-03 00:19:26 -0500
commit84fb6f83bda25ea3621214118691cef3afc28974 (patch)
treee500e5e398f69a9641af73fe2dfc9feb53eff642 /networkx/relabel.py
parentf1e8e8bbfe9d324a2c3f46f28f7bb292ea78cc3b (diff)
downloadnetworkx-84fb6f83bda25ea3621214118691cef3afc28974.tar.gz
Added clarifying comment about relabelling nodes in situations where … (#2857)
* Added clarifying comment about relabelling nodes in situations where the order of nodes is important * wrap docstring
Diffstat (limited to 'networkx/relabel.py')
-rw-r--r--networkx/relabel.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/networkx/relabel.py b/networkx/relabel.py
index 85f5cf60..2d3dc257 100644
--- a/networkx/relabel.py
+++ b/networkx/relabel.py
@@ -192,6 +192,10 @@ def convert_node_labels_to_integers(G, first_label=0, ordering="default",
-----
Node and edge attribute data are copied to the new (relabeled) graph.
+ There is no guarantee that the relabeling of nodes to integers will
+ give the same two integers for two (even identical graphs).
+ Use the `ordering` argument to try to preserve the order.
+
See Also
--------
relabel_nodes