Skip to content

docs: deprecating a library #606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Jun 12, 2025
Merged

docs: deprecating a library #606

merged 15 commits into from
Jun 12, 2025

Conversation

RobPasMue
Copy link
Member

As title says - this documentation shows how to properly deprecate a library and the tasks involved on the @ansys/pyansys-core team side

@RobPasMue RobPasMue self-assigned this Jun 4, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New features or code improvements labels Jun 4, 2025
Copy link
Member

@jorgepiloto jorgepiloto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this, @RobPasMue. Just left some minor suggestions.

Copy link
Contributor

@SMoraisAnsys SMoraisAnsys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this guide line @RobPasMue, I left minor comments

Co-authored-by: Sébastien Morais <[email protected]>
@RobPasMue RobPasMue requested a review from jorgepiloto June 6, 2025 10:51
Copy link
Contributor

@MaxJPRey MaxJPRey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work.

Copy link
Contributor

@clatapie clatapie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, the content is clear for the PyAnsys developers and for the PyAnsys Core team.

@RobPasMue RobPasMue dismissed jorgepiloto’s stale review June 12, 2025 14:54

Points blocking have been left as they were after internal discussion

@RobPasMue RobPasMue merged commit 1a6f055 into main Jun 12, 2025
8 checks passed
@RobPasMue RobPasMue deleted the feat/deprecating branch June 12, 2025 14:54
github-actions bot pushed a commit that referenced this pull request Jun 12, 2025
* docs: deprecating a library

* docs: missing explanation

* fix: vale issues

* fix: pre-commit

* Update doc/source/how-to/deprecating.rst

* fix: removing ref

* fix: remove line

* Apply suggestions from code review

Co-authored-by: Kerry McAdams <[email protected]>

* Apply suggestions from code review

Co-authored-by: Sébastien Morais <[email protected]>

* Apply suggestions from code review

* Update doc/source/how-to/deprecating.rst

Co-authored-by: Sébastien Morais <[email protected]>

* docs: adding documentation banner

---------

Co-authored-by: Kerry McAdams <[email protected]>
Co-authored-by: Sébastien Morais <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New features or code improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants