Skip to content

Commit 28d211f

Browse files
committed
edit stub
1 parent 167d566 commit 28d211f

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

docs/writing/structure.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
Structuring Your Project
22
========================
33

4-
When we say structure we mean the decisions you make concerning
4+
By "structure" we mean the decisions you make concerning
55
how your project best meets its objective. We need to consider how to
66
best leverage Python's features to create clean, effective code.
7-
In practical terms structure means the actual files and folders that
8-
comprise your project as well as the way dependencies are handled within
9-
the code itself.
7+
In practical terms, "structure" means making clean code whose logic and
8+
dependencies are clear as well as how the files and folders are organized
9+
in the filesystem.
1010

11-
How does data flow through the project? What features and functions
12-
can be grouped together and isolated? By answering questions like these
13-
you can begin to plan, in a broad sense, what your finished product will
14-
look like.
11+
Which functions should go into which modules? How does data flow through
12+
the project? What features and functions can be grouped together and
13+
isolated? By answering questions like these you can begin to plan, in
14+
a broad sense, what your finished product will look like.
1515

1616
In this section we take a closer look at Python's module and import
1717
systems as they are the central element to enforcing structure in your
18-
project.
18+
project. We then discuss various perspectives on how to build code which
19+
can be extended and tested reliably.
1920

2021

2122
Structure is Key

0 commit comments

Comments
 (0)