Skip to content

Commit 37725aa

Browse files
RobPasMueklmcadams
andauthored
Apply suggestions from code review
Co-authored-by: Kerry McAdams <[email protected]>
1 parent 436ad19 commit 37725aa

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/source/how-to/deprecating.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ is used in this guide.
6666

6767
See an example at `PyAdditive Widgets deprecation issue`_.
6868

69-
4. **Adapt the README**: Update the library's README file to reflect the deprecation.
70-
This should include a clear notice at the top of the README, informing users that the
69+
4. **Adapt the README**: Update the library's ``README`` file to reflect the deprecation.
70+
This should include a clear notice at the top of the ``README``, informing users that the
7171
library is deprecated. See an example at `PyAdditive Widgets README`_.
7272

7373
5. **(Optional) Add a warning in the code**: If applicable, add a warning in the code itself to inform users
@@ -91,7 +91,7 @@ is used in this guide.
9191
of the library that includes the deprecation warning. This ensures that users who install
9292
the library in the future see the warning immediately.
9393

94-
7. **Archive the repository**: Once the deprecation issue is created and the README is updated,
94+
7. **Archive the repository**: Once the deprecation issue is created and the ``README`` is updated,
9595
you can archive the repository. This prevents any further changes to the repository and
9696
signals to users that the library is no longer maintained. To archive a repository, go to the
9797
repository settings and select "Archive this repository."

0 commit comments

Comments
 (0)