Skip to content
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

DOCS: Add v1.0 expected breaking changes #4843

Merged
merged 6 commits into from
Aug 8, 2024
Merged

Conversation

SMoraisAnsys
Copy link
Collaborator

As we are approaching release 1.0 it would be great to notify users that some breaking changes are expected to happend when migration to this new major version.

This PR addresses this aspect by mentioning the argument deprecation and the expected directory restructuration.
On top of it, other changes are mentioned as the naming consistency, data encapsulation, examples extraction, ...

I hope to link this PR with another one to warn users of this incoming changes when they import pyaedt.

@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@SMoraisAnsys SMoraisAnsys requested a review from PipKat June 24, 2024 15:13
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 24, 2024
Copy link

codecov bot commented Jun 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.51%. Comparing base (ff00db8) to head (15ffe96).
Report is 77 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4843      +/-   ##
==========================================
- Coverage   83.13%   81.51%   -1.63%     
==========================================
  Files         118      134      +16     
  Lines       54075    56828    +2753     
==========================================
+ Hits        44956    46324    +1368     
- Misses       9119    10504    +1385     

@SMoraisAnsys SMoraisAnsys marked this pull request as draft June 25, 2024 15:17
doc/source/release_1_0.rst Outdated Show resolved Hide resolved
doc/source/release_1_0.rst Outdated Show resolved Hide resolved
doc/source/release_1_0.rst Outdated Show resolved Hide resolved
doc/source/release_1_0.rst Outdated Show resolved Hide resolved
doc/source/release_1_0.rst Outdated Show resolved Hide resolved
doc/source/release_1_0.rst Outdated Show resolved Hide resolved
doc/source/release_1_0.rst Outdated Show resolved Hide resolved
doc/source/release_1_0.rst Outdated Show resolved Hide resolved
doc/source/release_1_0.rst Outdated Show resolved Hide resolved
doc/source/release_1_0.rst Outdated Show resolved Hide resolved
doc/source/release_1_0.rst Outdated Show resolved Hide resolved
doc/source/release_1_0.rst Outdated Show resolved Hide resolved
doc/source/release_1_0.rst Outdated Show resolved Hide resolved
Copy link
Member

@PipKat PipKat left a comment

Choose a reason for hiding this comment

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

Editorial comments!

doc/source/index.rst Outdated Show resolved Hide resolved
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
doc/source/release_1_0.rst Outdated Show resolved Hide resolved
doc/source/release_1_0.rst Show resolved Hide resolved
doc/source/release_1_0.rst Show resolved Hide resolved
doc/source/release_1_0.rst Show resolved Hide resolved
@SMoraisAnsys SMoraisAnsys marked this pull request as ready for review August 8, 2024 07:10
@SMoraisAnsys
Copy link
Collaborator Author

@PipKat Thanks a lot for your review !

Copy link
Member

@Samuelopez-ansys Samuelopez-ansys left a comment

Choose a reason for hiding this comment

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

Great! Looking forward these breaking changes :)

@SMoraisAnsys SMoraisAnsys merged commit a0806c7 into main Aug 8, 2024
46 checks passed
@SMoraisAnsys SMoraisAnsys deleted the docs/notify-release-1-0 branch August 8, 2024 12:49
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants