|
1 |
| -.. _coding_style: |
2 |
| - |
3 | 1 | Coding Style
|
4 |
| -************ |
5 |
| - |
6 |
| -PyAnsys libraries are expected to follow `PEP8`_ and |
7 |
| -be consistent in style and formatting with the 'big three' |
8 |
| -data science libraries: `NumPy`_, `SciPy`_, and `pandas`_. |
9 |
| - |
10 |
| -.. _NumPy: https://numpy.org/ |
11 |
| -.. _SciPy: https://www.scipy.org/ |
12 |
| -.. _pandas: https://pandas.pydata.org/ |
13 |
| -.. _PEP8: https://www.python.org/dev/peps/pep-0008/ |
| 2 | +############ |
14 | 3 |
|
| 4 | +Coding Style refers to the different rules defined in a software project which |
| 5 | +need to be followed when writing source code. These guidelines ensure that all |
| 6 | +the source code is going to look the same across the different files of the |
| 7 | +project. |
15 | 8 |
|
16 |
| -.. todo:: |
| 9 | +The PyAnsys ecosystem is composed by multiple projects. To unify the coding |
| 10 | +style among all projects, this coding style guideline was devised. |
17 | 11 |
|
18 |
| - * Describe flake8 standards (in subpage), include example ``.flake8`` |
19 |
| - with minimum standards. |
20 |
| - * Include anything we've written from other documentation either in |
21 |
| - this page or other pages. |
| 12 | +PyAnsys libraries are expected to follow `PEP 8`_ and be consistent in style and |
| 13 | +formatting with the 'big three' data science libraries: `NumPy`_, `SciPy`_, and |
| 14 | +`pandas`_. |
22 | 15 |
|
23 | 16 | .. toctree::
|
24 | 17 | :hidden:
|
25 | 18 | :maxdepth: 3
|
26 | 19 |
|
27 |
| - pep8_best_practices |
28 |
| - beyond_pep8 |
29 |
| - flake8 |
| 20 | + pep8 |
| 21 | + formatting-tools |
| 22 | + required-config |
| 23 | + |
| 24 | + |
| 25 | +.. LINKS AND REFERENCES |
| 26 | +
|
| 27 | +.. _NumPy: https://numpy.org/ |
| 28 | +.. _SciPy: https://www.scipy.org/ |
| 29 | +.. _pandas: https://pandas.pydata.org/ |
| 30 | +.. _PEP 8: https://www.python.org/dev/peps/pep-0008/ |
0 commit comments