Skip to content

Commit 8c7a743

Browse files
authored
Fix a couple of typos in CONTRIBUTING.md (#251)
Removes trailing spaces and fix a typo in the document.
1 parent e73c294 commit 8c7a743

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ the compiled extension).
3838

3939
Rust is the primary language of retworkx and all the functional code in the
4040
libraries is written in Rust. The Rust code in retworkx uses
41-
[rustfmt](https://github.com/rust-lang/rustfmt) to enfore consistent style.
41+
[rustfmt](https://github.com/rust-lang/rustfmt) to enforce consistent style.
4242
CI jobs are configured to ensure to check this. Luckily adapting your code is
4343
as simple as running:
4444

@@ -87,16 +87,16 @@ you can view locally in a web browser.
8787

8888
### Release Notes
8989

90-
It is important to document any end user facing changes when we release a new
91-
version of retworkx. The expectation is that if your code contribution has
92-
user facing changes that you will write the release documentation for these
93-
changes. This documentation must explain what was changed, why it was changed,
94-
and how users can either use or adapt to the change. The idea behind release
95-
documentation is that when a naive user with limited internal knowledge of the
96-
project is upgrading from the previous release to the new one, they should be
97-
able to read the release notes, understand if they need to update their
98-
program which uses retworkx, and how they would go about doing that. It
99-
ideally should explain why they need to make this change too, to provide the
90+
It is important to document any end user facing changes when we release a new
91+
version of retworkx. The expectation is that if your code contribution has
92+
user facing changes that you will write the release documentation for these
93+
changes. This documentation must explain what was changed, why it was changed,
94+
and how users can either use or adapt to the change. The idea behind release
95+
documentation is that when a naive user with limited internal knowledge of the
96+
project is upgrading from the previous release to the new one, they should be
97+
able to read the release notes, understand if they need to update their
98+
program which uses retworkx, and how they would go about doing that. It
99+
ideally should explain why they need to make this change too, to provide the
100100
necessary context.
101101

102102
To make sure we don't forget a release note or if the details of user facing
@@ -136,7 +136,7 @@ look something like::
136136
features:
137137
- |
138138
Added a new function, :func:`~retworkx.foo` that adds support for doing
139-
something to :class:`~retworkx.PyDiGraph` objects.
139+
something to :class:`~retworkx.PyDiGraph` objects.
140140
- |
141141
The :class:`~retworkx.PyDiGraph` class has a new method
142142
:meth:`~retworkx.PyDiGraph.foo``. This is the equivalent of calling the

0 commit comments

Comments
 (0)