Skip to content

Commit

Permalink
DOCS: Fix release_1_0.rst (#5108)
Browse files Browse the repository at this point in the history
  • Loading branch information
gmalinve authored Aug 30, 2024
1 parent 54fcc25 commit 025f893
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions doc/source/release_1_0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ Restructuring of the codebase
-----------------------------

To facilitate the maintenance of PyAEDT and to adhere to PyAnsys' guidelines, the codebase
is being restructured. The sources are to be moved from ``pyaedt`` to ``src.ansys.aedt``
is being restructured. The sources are to be moved from ``pyaedt`` to ``ansys.aedt.core``
to improve the organization and maintainability of the codebase.

The changes to the structure follow:
The changes follow the structure below:

.. code-block:: text
Expand All @@ -49,8 +49,9 @@ The changes to the structure follow:
src/
└── ansys/
└── aedt/
├── application/
├── ...
└── core/
├── application/
├── ...
When migrating to major release `1.0`, please update any references or imports in your project
accordingly. An example of migration is shown below:
Expand Down Expand Up @@ -175,8 +176,8 @@ Other changes in release 1.0

In addition to the major changes described earlier, modifications are continuously performed to
improve the quality of the project, its maintainability, its documentation, and
to ensure users' need are met as efficiently as possible. This includes ensuring
consistent argument names, improving data encapsulation, strengthening CI/CD, and extracting
examples to a dedicated project.
to ensure users' needs are met as efficiently as possible. This includes ensuring
consistent argument names, improving data encapsulation, strengthening CI/CD, and migrate
examples to a different repository.

For more information on the status of the 1.0 release, see `PyAEDT Milestone <https://github.com/ansys/pyaedt/milestone/3>`_ .

0 comments on commit 025f893

Please sign in to comment.