Skip to content

Commit a2d1571

Browse files
authored
Rename 'Abstraction and Encapsulation' to 'Guidelines'. Also, change the order from 'Overview', 'Library Overview', 'Guidelines' to 'Overview', 'Guidelines', 'Library Overview'. Move 'dev practices' section under 'Guidelines'. (#22)
1 parent 1bf0fb9 commit a2d1571

File tree

8 files changed

+21
-23
lines changed

8 files changed

+21
-23
lines changed

doc/source/abstraction/index.rst

Lines changed: 0 additions & 21 deletions
This file was deleted.

doc/source/guidelines/index.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Guidelines
2+
#############################
3+
The purpose of this section is to highligh some common practices that
4+
can be applied to the entire PyAnsys project in order to remain consistent.
5+
6+
One of the main objectives of PyAnsys libraries is to wrap (encapsulate)
7+
data and methods within units of execution while hiding data or parameters
8+
in protected variables.
9+
10+
Those guidelines demonstrate how applications and complex services expose
11+
functionalities such as logging, data transfer...
12+
13+
.. toctree::
14+
:hidden:
15+
:maxdepth: 3
16+
17+
dev_practices
18+
app_interface_abstraction
19+
service_abstraction
20+
data_transfer_and_representation

doc/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
:maxdepth: 3
99

1010
overview/index
11+
guidelines/index
1112
library_description/index
12-
abstraction/index
1313
coding_style/index
1414
documentation_style/index

doc/source/overview/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ PROTO files, create coverage reports, and report on system coverage:
6666
basic
6767
administration
6868
contributing
69-
dev_practices
7069

7170
.. _PyAEDT: https://github.com/pyansys/PyAEDT
7271
.. _PyMAPDL: https://github.com/pyansys/pymapdl

0 commit comments

Comments
 (0)