diff options
Diffstat (limited to 'doc/release/migration_guide_from_2.x_to_3.0.rst')
| -rw-r--r-- | doc/release/migration_guide_from_2.x_to_3.0.rst | 23 |
1 files changed, 6 insertions, 17 deletions
diff --git a/doc/release/migration_guide_from_2.x_to_3.0.rst b/doc/release/migration_guide_from_2.x_to_3.0.rst index a7dc8a4f..8035f4d3 100644 --- a/doc/release/migration_guide_from_2.x_to_3.0.rst +++ b/doc/release/migration_guide_from_2.x_to_3.0.rst @@ -1,8 +1,8 @@ :orphan: -***************************** -Preparing for the 3.0 release -***************************** +******************************* +Migration guide from 2.X to 3.0 +******************************* .. note:: Much of the work leading to the NetworkX 3.0 release will be included @@ -11,7 +11,7 @@ Preparing for the 3.0 release ongoing work and will help you understand what changes you can make now to minimize the disruption caused by the move to 3.0. -This is a guide for people moving from NetworkX 2.X to NetworkX 3.0 +This is a guide for people moving from NetworkX 2.X to NetworkX 3.0. Any issues with these can be discussed on the `mailing list <https://groups.google.com/forum/#!forum/networkx-discuss>`_. @@ -34,9 +34,6 @@ structures (``Graph``, ``DiGraph``, etc.) and common algorithms, but some functionality, e.g. functions found in the ``networkx.linalg`` package, are only available if these additional libraries are installed. -.. **TODO**: Generate a table showing dependencies of individual nx objects? -.. Probably overkill... - Improved integration with scientific Python ------------------------------------------- @@ -179,15 +176,7 @@ improving supported for array representations of multi-attribute adjacency:: Deprecated code --------------- -The 2.6 release deprecates over 30 functions. -See :ref:`networkx_2.6`. - -.. **TODO**: A table summarizing one deprecation per row w/ 3 columns: 1. the -.. deprecated function, 2. the old usage, 3. the replacement usage. - ---- - -The functions `read_gpickle` and `write_gpickle` will be removed in 3.0. +The functions `read_gpickle` and `write_gpickle` were removed in 3.0. You can read and write NetworkX graphs as Python pickles. >>> import pickle @@ -199,7 +188,7 @@ You can read and write NetworkX graphs as Python pickles. ... G = pickle.load(f) ... -The functions `read_yaml` and `write_yaml` will be removed in 3.0. +The functions `read_yaml` and `write_yaml` were removed in 3.0. You can read and write NetworkX graphs in YAML format using pyyaml. |