From f5b34bbbfa628638e2fef9cd7e37ee9b02b72ec4 Mon Sep 17 00:00:00 2001 From: Prashanth Rao <35005448+prrao87@users.noreply.github.com> Date: Mon, 19 Feb 2024 20:24:49 -0500 Subject: [PATCH] Typo and clarity updates (#1092) --- docs/source/benchmarks.rst | 4 ++-- docs/source/networkx.rst | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/benchmarks.rst b/docs/source/benchmarks.rst index ffbee275b..959573ae3 100644 --- a/docs/source/benchmarks.rst +++ b/docs/source/benchmarks.rst @@ -2,7 +2,7 @@ Rustworkx Comparison Benchmarks With Other Libraries **************************************************** -rustworkx is competitive against other popular graph libraries for Python. We compared rustworkx to the igraph, graph-tools and NetworkIt libraries `in a benchmark consisting of four tasks available on Github for reproducibility `__ . We report the results from a machine with an Intel(R) i9-9900K CPU at 3.60GHz with eight cores, 16 theads, and 32GB of RAM avaialble. +rustworkx is competitive against other popular graph libraries for Python. We compared rustworkx to the igraph, graph-tools and NetworkIt libraries `in a benchmark consisting of four tasks available on Github for reproducibility `__. We report the results from a machine with an Intel(R) i9-9900K CPU at 3.60GHz with eight cores, 16 theads, and 32GB of RAM avaialble. Graph Creation ============== @@ -28,7 +28,7 @@ The third benchmark is to calculate the distance among all nodes in a weighted g Subgraph Isomorphism ==================== -Lastly, the fourth benchamrk is about graph isomorphism. We compare the time to answer if pairs of graphs from the ARG Database are subgraph-isomorphic (De Santo et al., 2003). See :func:`~rustworkx.is_subgraph_isomorphic` for more information on the benchmarked function. +Lastly, the fourth benchmark is about graph isomorphism. We compare the time to answer if pairs of graphs from the ARG Database are subgraph-isomorphic (De Santo et al., 2003). See :func:`~rustworkx.is_subgraph_isomorphic` for more information on the benchmarked function. .. image:: /images/subgraph_isomorphism.svg diff --git a/docs/source/networkx.rst b/docs/source/networkx.rst index f56d63fe2..5e79ae0fc 100644 --- a/docs/source/networkx.rst +++ b/docs/source/networkx.rst @@ -14,8 +14,8 @@ Some Key Differences rustworkx (as the name implies) was inspired by networkx and the goal of the project is to provide a similar level of functionality and utility to what networkx offers but with much faster performance. However, because of -limitations in the boundary between rust and python, different design -decisions, and other differences the libraries are not identical. +limitations in the boundary between rust and python, design +decisions and other aspects of the libraries are not identical. The biggest difference to keep in mind is networkx is a very dynamic in how it can be used. It allows you to treat a graph object associatively (like a python @@ -411,9 +411,9 @@ networkx graph then you can use :func:`rustworkx.networkx_converter` to convert that networkx ``Graph`` object into an equivalent rustworkx :class:`~rustworkx.PyGraph` or :class:`~rustworkx.PyDiGraph` object. Note that networkx is **not** a dependency for rustworkx and you are responsible for -installing networkx to use this function. Accordingly, there is not equivalent -function provided to convert the reverse direction (because doing so would add -an unwanted dependency on networkx, even an optional one) but writing such a +installing networkx to use this function. Accordingly, there isn't an equivalent +function provided to convert in the reverse direction (because doing so would add +an unwanted dependency on networkx, even if it is an optional one). However, writing such a function is straightforward, for example:: import networkx as nx