Skip to content

Commit d665bce

Browse files
jorgepilotoPipKat
andauthored
Apply suggestions from code review
Co-authored-by: Kathy Pippert <[email protected]>
1 parent 57bc33b commit d665bce

File tree

2 files changed

+12
-15
lines changed

2 files changed

+12
-15
lines changed

doc/source/packaging/structure.rst

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,25 @@ Project Structure
55
#################
66

77
Most of the projects in the PyAnsys ecosystem ship in the form of a Python
8-
Package. This is the formal way of distributing Python-based projects.
8+
package. This is the formal way of distributing Python-based projects.
99

1010
The guide presented in this page is compliant with the `Python Packaging
11-
Authority`_ and the `PyAnsys`_ recommendations.
11+
Authority`_ and `PyAnsys`_ recommendations.
1212

1313
.. note::
1414

15-
The best way to keep up-to-date with Python Packaging is to check the `Python
15+
The best way to keep up to date with Python packaging is to check the `Python
1616
Packaging User Guide`_, maintained by the `Python Packaging Authority`_ (PyPA).
17-
PyAnsys guidelines are build on top of PyPA ones.
17+
PyAnsys guidelines are built on top of PyPA guidelines.
1818

1919

2020
.. TODO: Explain the difference between Package and Library?
2121
Package: only holds modules
2222
Library: a collection of packages
2323
2424
25-
PyAnsys Project Required Files
26-
==============================
25+
Required Files for a PyAnsys Project
26+
====================================
2727

2828
The fundamental PyAnsys Library structure is composed by the following files and
2929
directories:
@@ -53,16 +53,13 @@ directories:
5353
├── pyproject.toml
5454
└── setup.py (optional)
5555
56-
The following directories can be identified in previous structure:
56+
Descriptions follow for some of the directories in the structure:
5757

58-
- ``doc/`` is devoted to store any piece of information related to documentation,
59-
guidelines and examples.
58+
- ``doc/`` contains files related to documentation, guidelines, and examples.
6059

61-
- ``src/`` is used to collect all the Python modules and scripts that form
62-
the project.
60+
- ``src/`` contains all Python modules and scripts that form the project.
6361

64-
- ``tests/`` stores all the unit tests whose purpose is to check the integrity
65-
of the project.
62+
- ``tests/`` contains all unit tests for checking the integrity of the project.
6663

6764

6865
The ``doc/`` Directory

doc/source/packaging/templates.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ PyAnsys coding and API style guidelines.
1212
The ``ansys-templates`` tool
1313
============================
1414

15-
The `ansys-templates`_ is a command line interface which provides you with a
16-
collection of templates. This tool allows you to create new PyAnsys projects
15+
The `ansys-templates`_ is a command line interface that provides you with a
16+
collection of templates. This tool allows you to create new PyAnsys projects.
1717
from scratch in a dynamic way by asking you several questions before generating
1818
the new project.
1919

0 commit comments

Comments
 (0)