search

ansys / pyaedt

AEDT Python Client Package
https://aedt.docs.pyansys.com
MIT License
185 stars 101 forks source link

DOCS: Add v1.0 expected breaking changes #4843

Open SMoraisAnsys opened 1 week ago

SMoraisAnsys commented 1 week ago

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[bot] commented 1 week ago

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

@ansys-reviewer-bot review

codecov[bot] commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 83.14%. Comparing base (ff00db8) to head (dc2a433). Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #4843 +/- ## ======================================= Coverage 83.13% 83.14% ======================================= Files 118 118 Lines 54075 54075 ======================================= + Hits 44956 44958 +2 + Misses 9119 9117 -2 ```