Skip to content

Add the Guidelines section. #22

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

Merged
merged 1 commit into from
Dec 30, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions doc/source/abstraction/index.rst

This file was deleted.

20 changes: 20 additions & 0 deletions doc/source/guidelines/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Guidelines
#############################
The purpose of this section is to highligh some common practices that
can be applied to the entire PyAnsys project in order to remain consistent.

One of the main objectives of PyAnsys libraries is to wrap (encapsulate)
data and methods within units of execution while hiding data or parameters
in protected variables.
Comment on lines +6 to +8
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@akaszynski I kept this paragraph because it is quite generic. But I am not really sure it fits here.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's fine to leave this in.


Those guidelines demonstrate how applications and complex services expose
functionalities such as logging, data transfer...

.. toctree::
:hidden:
:maxdepth: 3

dev_practices
app_interface_abstraction
service_abstraction
data_transfer_and_representation
2 changes: 1 addition & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
:maxdepth: 3

overview/index
guidelines/index
library_description/index
abstraction/index
coding_style/index
documentation_style/index
1 change: 0 additions & 1 deletion doc/source/overview/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ PROTO files, create coverage reports, and report on system coverage:
basic
administration
contributing
dev_practices

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