Skip to content

Commit fc78bc8

Browse files
committed
fix: vale issues
1 parent 06bd9ea commit fc78bc8

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

doc/source/how-to/deprecating.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ As time passes, some libraries may become outdated or replaced by better alterna
77
When this happens, it is important to deprecate the old library properly to ensure users
88
are aware of the change and can transition smoothly.
99

10-
In the PyAnsys ecosystem, we follow a specific process for deprecating libraries.
11-
This process helps maintain clarity and consistency across our projects.
10+
For the PyAnsys ecosystem, follow this specific process for deprecating libraries.
11+
This process helps maintain clarity and consistency across the projects.
1212

1313
Maintainer tasks
1414
----------------
@@ -28,14 +28,14 @@ is used in this guide.
2828
open issues and pull requests in the library's repository are closed. This helps to avoid
2929
confusion and ensures that users are aware that the library is no longer actively maintained.
3030
You can close issues and pull requests with a comment explaining that the library is being
31-
deprecated and will no longer be supported.
31+
deprecated and is no longer be supported.
3232
3. **Create a deprecation issue**: Open an issue in the library's repository to announce the
3333
deprecation. This issue should explain why the library is being deprecated, what alternatives
3434
are available, and any relevant timelines. See a template below for the issue content.
3535

3636
.. warning::
3737

38-
Make sure to adapt the template to your specific library and situation!
38+
Make sure to adapt the template to your specific library and situation.
3939

4040
.. code:: markdown
4141
@@ -58,7 +58,7 @@ is used in this guide.
5858
5959
Thank you to everyone who contributed, used, or supported this project!
6060
61-
This issue will serve as a permanent record of the deprecation and provide users with
61+
This issue serves as a permanent record of the deprecation and provide users with
6262
necessary information about alternatives.
6363

6464
Make sure to pin the issue to the top of the repository so that it is easily visible to users.
@@ -89,12 +89,12 @@ is used in this guide.
8989

9090
6. **(Optional) Make a last release**: If you carried out step 5, consider making a final release
9191
of the library that includes the deprecation warning. This ensures that users who install
92-
the library in the future will see the warning immediately.
92+
the library in the future see the warning immediately.
9393

9494
7. **Archive the repository**: Once the deprecation issue is created and the README is updated,
95-
you can archive the repository. This will prevent any further changes to the repository and
96-
signal to users that the library is no longer maintained. To archive a repository, go to the
97-
repository settings and select "Archive this repository".
95+
you can archive the repository. This prevents any further changes to the repository and
96+
signals to users that the library is no longer maintained. To archive a repository, go to the
97+
repository settings and select "Archive this repository."
9898

9999
These steps ensure that the deprecation process is clear and transparent, allowing users to
100100
transition smoothly to alternatives while maintaining the integrity of the PyAnsys ecosystem.
@@ -107,7 +107,7 @@ transition smoothly to alternatives while maintaining the integrity of the PyAns
107107
Core team tasks
108108
---------------
109109

110-
The PyAnsys Core team will assist with the deprecation process by:
110+
The PyAnsys Core team is responsbile for assisting with the deprecation process by:
111111

112112
- Reviewing the deprecation issue to ensure it meets the project's standards.
113113
- Assisting with the above steps, if necessary.

0 commit comments

Comments
 (0)