Skip to content

Commit 167d566

Browse files
committed
add stub
1 parent fcefab9 commit 167d566

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

docs/writing/structure.rst

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

4-
Structuring your project properly is extremely important.
4+
When we say structure we mean the decisions you make concerning
5+
how your project best meets its objective. We need to consider how to
6+
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.
10+
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.
15+
16+
In this section we take a closer look at Python's module and import
17+
systems as they are the central element to enforcing structure in your
18+
project.
519

6-
.. todo:: Fill in "Structuring Your Project" stub
720

821
Structure is Key
922
----------------

0 commit comments

Comments
 (0)