-
Notifications
You must be signed in to change notification settings - Fork 127
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
Conversation
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
Codecov ReportAll modified and coverable lines are covered by tests ✅
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Editorial comments!
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@PipKat Thanks a lot for your review ! |
There was a problem hiding this 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 :)
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.