Skip to content

Commit 7fe8925

Browse files
authored
Fix some typos in docs (#1394)
1 parent 286a719 commit 7fe8925

File tree

16 files changed

+28
-28
lines changed

16 files changed

+28
-28
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ are no changes made to the rust code. To avoid this you can use the
119119
`--no-install` package if you'd like to rerun tests without recompiling.
120120
Note, you only want to use this flag if you recently ran Nox and there are no
121121
rust code (or packaged python code) changes to the repo since then. Otherwise
122-
the rustworkx package Nox installs in it's virtualenv will be out of date (or
122+
the rustworkx package Nox installs in its virtualenv will be out of date (or
123123
missing).
124124
125125
Note, if you run tests outside of Nox that you can **not** run the tests from
@@ -194,8 +194,8 @@ the run finishes so you can inspect the output.
194194
195195
#### rustworkx-core tests
196196
197-
As rustworkx-core is a standalone rust crate with it's own public interface it
198-
needs it's own testing. These tests can be a combination of doc tests (embedded
197+
As rustworkx-core is a standalone rust crate with its own public interface it
198+
needs its own testing. These tests can be a combination of doc tests (embedded
199199
code examples in the docstrings in the rust code) or standalone tests. You
200200
can refer to the rust book on how to add tests:
201201

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ environment.
5858
### Installing on a platform without precompiled binaries
5959

6060
If there are no precompiled binaries published for your system you'll have to
61-
build the package from source. However, to be able able to build the package
61+
build the package from source. However, to be able to build the package
6262
from the published source package you need to have Rust >= 1.70 installed (and
6363
also [cargo](https://doc.rust-lang.org/cargo/) which is normally included with
6464
rust) You can use [rustup](https://rustup.rs/) (a cross platform installer for
@@ -177,6 +177,6 @@ NetworkX usage (hence the original name). The project was originally started
177177
to build a faster directed graph to use as the underlying data structure for
178178
the DAG at the center of
179179
[qiskit](https://github.com/Qiskit/qiskit/)'s transpiler. However,
180-
since it's initial introduction the project has grown substantially and now
180+
since its initial introduction the project has grown substantially and now
181181
covers all applications that need to work with graphs which includes
182182
Qiskit.

docs/source/install.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Installing on a platform without precompiled binaries
2525
-----------------------------------------------------
2626

2727
If there are no precompiled binaries published for your system you'll have to
28-
build the package from source. However, to be able able to build the package from
28+
build the package from source. However, to be able to build the package from
2929
the published source package you need to have Rust >= 1.64 installed (and also
3030
cargo which is normally included with rust) You can use
3131
`rustup <https://rustup.rs/>`_ (a cross platform installer for rust) to make this

docs/source/networkx.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ graph and matrices in other libraries. This includes ``to_numpy_matrix()``,
327327
adjacency matrix).
328328

329329
However, in rustworkx there is **only** a :meth:`~rustworkx.adjacency_matrix`
330-
function (and it's per type variants :meth:`~rustworkx.digraph_adjacency_matrix`
330+
function (and its per type variants :meth:`~rustworkx.digraph_adjacency_matrix`
331331
and :meth:`~rustworkx.graph_adjacency_matrix`) which will return a numpy array
332332
of the adjacency matrix (**not** a scipy csr sparse matrix like networkx's
333333
function). This function is equivalent to networkx's ``to_numpy_array()``

docs/source/release_notes.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ New Features
185185
:meth:`~rustworkx.PyDiGraph.insert_node_on_in_edges_multiple`, and
186186
:meth:`~rustworkx.PyDiGraph.insert_node_on_out_edges_multiple` were added to
187187
:class:`~rustworkx.PyDiGraph`. These functions are used to insert an existing
188-
node in between an reference node(s) and all it's predecessors or successors.
188+
node in between an reference node(s) and all its predecessors or successors.
189189
- Two new functions, :func:`~rustworkx.graph_dfs_edges` and
190190
:func:`~rustworkx.digraph_dfs_edges`, were added to get an edge list in depth
191191
first order from a :class:`~rustworkx.PyGraph` and
@@ -356,7 +356,7 @@ Upgrade Notes
356356
-------------
357357

358358
- The :class:`~rustworkx.PyDAG` class was renamed :class:`~rustworkx.PyDiGraph`
359-
to better reflect it's functionality. For backwards compatibility
359+
to better reflect its functionality. For backwards compatibility
360360
:class:`~rustworkx.PyDAG` still exists as a Python subclass of
361361
:class:`~rustworkx.PyDiGraph`. No changes should be required for existing
362362
users.

docs/source/tutorial/dags.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ performed is:
205205

206206
# Equivalency matrix
207207
translation_matrix = {"h": ["rz(pi/2)", "sx", "rz(pi/2)"]}
208-
# Insructions natively supported on target QPU
208+
# Instructions natively supported on target QPU
209209
hardware_instructions = {"measure", "cx", "sx", "rz", "x"}
210210

211211
# Iterate over instructions in order and replace gates outside of native

docs/source/tutorial/introduction.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ In the above cases, we were adding nodes with a data payload of type integer (e.
9797
However, rustworkx doesn't place constraints on what the node data payload can
9898
be, so you can use more involved objects including types which are not
9999
`hashable <https://docs.python.org/3/glossary.html#term-hashable>`__. For
100-
example, we can add a node with a data payload that's a a
100+
example, we can add a node with a data payload that's a
101101
`dict <https://docs.python.org/3/library/stdtypes.html#dict>`__:
102102

103103
.. jupyter-execute::
@@ -219,7 +219,7 @@ Modifying elements of a graph
219219

220220
The graph classes in rustworkx also allow for in place mutation of the payloads
221221
for elements in the graph. For nodes you can simply use the mapping protocol to
222-
change the payload via it's node index. For example:
222+
change the payload via its node index. For example:
223223

224224
.. jupyter-execute::
225225

rustworkx-core/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ that offers a general purpose high performance graph library written in Rust,
1818
rustworkx-core is a pure rust library that offers a stable rust API for any
1919
downstream crate that need it.
2020

21-
At it's core rustworkx is built on top of the
21+
At its core rustworkx is built on top of the
2222
[petgraph](https://github.com/petgraph/petgraph) library and wraps it in a
2323
Python layer. However, many of the algorithms (and to a lesser extent data
2424
structures) needed for rustworkx are not available in petgraph. For places

rustworkx/__init__.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ class PyDAG(PyDiGraph):
125125
``PyDAG`` has runtime cycle detection enabled.
126126
:param bool multgraph: When this is set to ``False`` the created
127127
``PyDAG`` object will not be a multigraph. When ``False`` if a method
128-
call is made that would add parallel edges the the weight/weight from
128+
call is made that would add parallel edges the weight/weight from
129129
that method call will be used to update the existing edge in place.
130130
"""
131131

@@ -596,7 +596,7 @@ def k_shortest_path_lengths(graph, start, k, edge_cost, goal=None):
596596
:param int start: The node index to find the shortest paths from
597597
:param int k: The kth shortest path to find the lengths of
598598
:param edge_cost: A python callable that will receive an edge payload and
599-
return a float for the cost of that eedge
599+
return a float for the cost of that edge
600600
:param int goal: An optional goal node index, if specified the output
601601
dictionary
602602
@@ -732,7 +732,7 @@ def is_isomorphic_node_match(first, second, matcher, id_order=True):
732732
It should be the same type as the first graph.
733733
:param callable matcher: A python callable object that takes 2 positional
734734
one for each node data object. If the return of this
735-
function evaluates to True then the nodes passed to it are vieded
735+
function evaluates to True then the nodes passed to it are viewed
736736
as matching.
737737
:param bool id_order: If set to ``False`` this function will use a
738738
heuristic matching order based on [VF2]_ paper. Otherwise it will
@@ -1144,7 +1144,7 @@ def closeness_centrality(graph, wf_improved=True):
11441144
11451145
The closeness centrality of a node :math:`u` is defined as the
11461146
reciprocal of the average shortest path distance to :math:`u` over all
1147-
:math:`n-1` reachable nodes in the graph. In it's general form this can
1147+
:math:`n-1` reachable nodes in the graph. In its general form this can
11481148
be expressed as:
11491149
11501150
.. math::

src/centrality.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ pub fn out_degree_centrality(graph: &digraph::PyDiGraph) -> PyResult<CentralityM
265265
///
266266
/// The closeness centrality of a node :math:`u` is defined as the
267267
/// reciprocal of the average shortest path distance to :math:`u` over all
268-
/// :math:`n-1` reachable nodes in the graph. In it's general form this can
268+
/// :math:`n-1` reachable nodes in the graph. In its general form this can
269269
/// be expressed as:
270270
///
271271
/// .. math::
@@ -313,7 +313,7 @@ pub fn graph_closeness_centrality(graph: &graph::PyGraph, wf_improved: bool) ->
313313
///
314314
/// The closeness centrality of a node :math:`u` is defined as the
315315
/// reciprocal of the average shortest path distance to :math:`u` over all
316-
/// :math:`n-1` reachable nodes in the graph. In it's general form this can
316+
/// :math:`n-1` reachable nodes in the graph. In its general form this can
317317
/// be expressed as:
318318
///
319319
/// .. math::

0 commit comments

Comments
 (0)