Skip to content

Commit 8c63fd0

Browse files
cleaned up docstring formatting and removed unnecessary asterisks
1 parent 9efe6c2 commit 8c63fd0

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

patterns/creational/builder.py

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
"""
2-
*What is this pattern about?
2+
What is this pattern about?
33
It decouples the creation of a complex object and its representation,
44
so that the same process can be reused to build objects from the same
55
family.
66
This is useful when you must separate the specification of an object
77
from its actual representation (generally for abstraction).
88
9-
*What does this example do?
10-
9+
What does this example do?
1110
The first example achieves this by using an abstract base
1211
class for a building, where the initializer (__init__ method) specifies the
1312
steps needed, and the concrete subclasses implement these steps.
@@ -22,16 +21,15 @@ class for a building, where the initializer (__init__ method) specifies the
2221
In general, in Python this won't be necessary, but a second example showing
2322
this kind of arrangement is also included.
2423
25-
*Where is the pattern used practically?
26-
27-
*References:
28-
https://sourcemaking.com/design_patterns/builder
24+
Where is the pattern used practically?
25+
See: https://sourcemaking.com/design_patterns/builder
2926
30-
*TL;DR
27+
TL;DR
3128
Decouples the creation of a complex object and its representation.
3229
"""
3330

3431

32+
3533
# Abstract Building
3634
class Building:
3735
def __init__(self) -> None:

0 commit comments

Comments
 (0)