File tree Expand file tree Collapse file tree 1 file changed +3
-3
lines changed Expand file tree Collapse file tree 1 file changed +3
-3
lines changed Original file line number Diff line number Diff line change @@ -66,8 +66,8 @@ is used in this guide.
66
66
67
67
See an example at `PyAdditive Widgets deprecation issue `_.
68
68
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
71
71
library is deprecated. See an example at `PyAdditive Widgets README `_.
72
72
73
73
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.
91
91
of the library that includes the deprecation warning. This ensures that users who install
92
92
the library in the future see the warning immediately.
93
93
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,
95
95
you can archive the repository. This prevents any further changes to the repository and
96
96
signals to users that the library is no longer maintained. To archive a repository, go to the
97
97
repository settings and select "Archive this repository."
You can’t perform that action at this time.
0 commit comments