diff options
| author | Jarrod Millman <jarrod.millman@gmail.com> | 2022-07-12 01:08:34 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-12 11:08:34 +0300 |
| commit | 87393d22b338a53f8f2d68c51b94e30f2ea59e37 (patch) | |
| tree | 2fc240f31c3ad1918dc441410979477831821681 /doc/reference/classes | |
| parent | 5ab33773c5e716ebbf6311771272f6d603c5cd49 (diff) | |
| download | networkx-87393d22b338a53f8f2d68c51b94e30f2ea59e37.tar.gz | |
Remove OrderedGraphs (#5813)
Removes the deprecated OrderedGraph classes.
Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
Co-authored-by: Dan Schult <dschult@colgate.edu>
Diffstat (limited to 'doc/reference/classes')
| -rw-r--r-- | doc/reference/classes/index.rst | 10 | ||||
| -rw-r--r-- | doc/reference/classes/ordered.rst | 13 |
2 files changed, 3 insertions, 20 deletions
diff --git a/doc/reference/classes/index.rst b/doc/reference/classes/index.rst index acd9e259..4e1c331a 100644 --- a/doc/reference/classes/index.rst +++ b/doc/reference/classes/index.rst @@ -40,13 +40,9 @@ Basic graph types ordered .. note:: NetworkX uses `dicts` to store the nodes and neighbors in a graph. - So the reporting of nodes and edges for the base graph classes will not - necessarily be consistent across versions and platforms. If you need the - order of nodes and edges to be consistent (e.g., when writing automated - tests), please see :class:`~networkx.OrderedGraph`, - :class:`~networkx.OrderedDiGraph`, :class:`~networkx.OrderedMultiGraph`, - or :class:`~networkx.OrderedMultiDiGraph`, which behave like the base - graph classes but give a consistent order for reporting of nodes and edges. + So the reporting of nodes and edges for the base graph classes may not + necessarily be consistent across versions and platforms; however, the reporting + for CPython is consistent across platforms and versions after 3.6. Graph Views =========== diff --git a/doc/reference/classes/ordered.rst b/doc/reference/classes/ordered.rst deleted file mode 100644 index c9bd45fd..00000000 --- a/doc/reference/classes/ordered.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _ordered: - -============================================ -Ordered Graphs---Consistently ordered graphs -============================================ - -.. automodule:: networkx.classes.ordered - -.. currentmodule:: networkx -.. autoclass:: OrderedGraph -.. autoclass:: OrderedDiGraph -.. autoclass:: OrderedMultiGraph -.. autoclass:: OrderedMultiDiGraph |