Skip to content

Commit 80d65f1

Browse files
committed
Fix uppercase after semicolon
1 parent f79316c commit 80d65f1

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/writing/structure.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Easy structuring of a project means it is also easy
1919
to do it poorly. Some signs of a poorly structured project
2020
include:
2121

22-
- Multiple and messy circular dependencies: If your classes
22+
- Multiple and messy circular dependencies: if your classes
2323
Table and Chair in furn.py need to import Carpenter from workers.py
2424
to answer a question such as table.isdoneby(),
2525
and if conversely the class Carpenter needs to import Table and Chair,
@@ -28,13 +28,13 @@ include:
2828
fragile hacks such has using import statements inside
2929
methods or functions.
3030

31-
- Hidden coupling: Each and every change in Table's implementation
31+
- Hidden coupling: each and every change in Table's implementation
3232
breaks 20 tests in unrelated test cases because it breaks Carpenter's code,
3333
which requires very careful surgery to adapt the change. This means
3434
you have too many assumptions about Table in Carpenter's code or the
3535
reverse.
3636

37-
- Heavy usage of global state or context: Instead of explicitly
37+
- Heavy usage of global state or context: instead of explicitly
3838
passing ``(height, width, type, wood)`` to each other, Table
3939
and Carpenter rely on global variables that can be modified
4040
and are modified on the fly by different agents. You need to
@@ -43,14 +43,14 @@ include:
4343
template code is also modifying this context, messing with
4444
table dimensions.
4545

46-
- Spaghetti code: Multiple pages of nested if clauses and for loops
46+
- Spaghetti code: multiple pages of nested if clauses and for loops
4747
with a lot of copy-pasted procedural code and no
48-
proper segmentation are known as spaghetti code. Python's
48+
proper segmentation are known as spaghetti code. Python's
4949
meaningful indentation (one of its most controversial features) make
5050
it very hard to maintain this kind of code. So the good news is that
5151
you might not see too much of it.
5252

53-
- Ravioli code is more likely in Python: It consists of hundreds of
53+
- Ravioli code is more likely in Python: it consists of hundreds of
5454
similar little pieces of logic, often classes or objects, without
5555
proper structure. If you never can remember if you have to use
5656
FurnitureTable, AssetTable or Table, or even TableNew for your

docs/writing/style.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ We are all consenting adults
186186
187187
As seen above, Python allows many tricks, and some of them are potentially
188188
dangerous. A good example is that any client code can override an object's
189-
properties and methods: There is no "private" keyword in Python. This
189+
properties and methods: there is no "private" keyword in Python. This
190190
philosophy, very different from highly defensive languages like Java, which
191191
give a lot of mechanism to prevent any misuse, is expressed by the saying: "We
192192
are consenting adults".

0 commit comments

Comments
 (0)