small fix

Author: thomasWeise

text/main/classes/basics/basics.tex

@@ -11,7 +11,7 @@
     """Docstring of the class."""
 
     def __init__(self) -> None:
-        """Docstring of the constructor __init__."""
+        """Docstring of the initializer __init__."""
         # initialize all attributes
         #: Meaning of attribute 1
         self.attribute_1: type hint = initial value
@@ -70,22 +70,22 @@
 A attribute is a variable that every single instance of the class has.
 In other words, we later want to be able to create one instance of \pythonil{Point} with the x\nobreakdashes-coordinate~5 and the y\nobreakdashes-coordinate~10 and then another instance with the x\nobreakdashes-coordinate~2 and the y\nobreakdashes-coordinate~7.
 
-Therefore, \pythonil{Point} needs a constructor, i.e., a special method that creates these attributes.
+Therefore, \pythonil{Point} needs a initializer, i.e., a special method that creates these attributes.
 This method is called~\pythonilIdx{\_\_init\_\_}.
 As said, every method of a class must have a parameter~\pythonilIdx{self}, which is the instance of the class (the object) upon which the method is called.
-The constructor \pythonilIdx{\_\_init\_\_} is a special method, so it also has this parameter~\pythonilIdx{self}.
+The initializer \pythonilIdx{\_\_init\_\_} is a special method, so it also has this parameter~\pythonilIdx{self}.
 Additionally, we demand that two parameters~\pythonil{x} and~\pythonil{y} be passed in when we create an instance of~\pythonil{Point}.
 We allow the values to be either \pythonils{int} or \pythonils{float}.%
 %
 \bestPractice{attributes}{%
-Object attributes must only be created inside the constructor~\pythonilIdx{\_\_init\_\_}. %
+Object attributes must only be created inside the initializer~\pythonilIdx{\_\_init\_\_}. %
 An initial value must immediately be assigned to each attribute.%
 }
 %
 We only want to allow \pythonils{Point} that have finite coordinates.
 As explained in the \cref{sec:exceptions} on \pythonilsIdx{Exception}, it is better to immediately signal errors if we encounter invalid data.
 So we want to sort out non-finite coordinates right when someone attempts to create the \pythonil{Point} object.
-Thus, the first thing we do in the constructor is to use the \pythonilIdx{isfinite} function from the \pythonilIdx{math} module.
+Thus, the first thing we do in the initializer is to use the \pythonilIdx{isfinite} function from the \pythonilIdx{math} module.
 If either \pythonil{x} or \pythonil{y} is not finite, then we raise\pythonIdx{raise} a \pythonilIdx{ValueError}.
 Otherwise, we set \pythonil{self.x: Final[int | float] = x} and \pythonil{self.y: Final[int | float] = y}.\footnote{%
 Strictly speaking, it could also make sense to check whether \pythonil{x} and \pythonil{y} are indeed either \pythonil{int} or \pythonil{float}. %
@@ -97,7 +97,7 @@
 In other words, we do not allow the coordinates of our \pythonils{Point} to be change after creation.%
 %
 \bestPractice{attributeTypeHint}{%
-Every attribute of an object must be annotated with a \pgls{typeHint} and a documentation comment when created in the constructor~\pythonilIdx{\_\_init\_\_}. %
+Every attribute of an object must be annotated with a \pgls{typeHint} and a documentation comment when created in the initializer~\pythonilIdx{\_\_init\_\_}. %
 \pglspl{typeHint} work as with normal variables, but the documentation is slightly different: %
 In the line \emph{above} the attribute initialization, a \emph{comment} starting with \pythonilIdx{\#: } must be written which explains the meaning of the attribute.%
 }%
@@ -140,7 +140,7 @@
 For \pythonil{p1}, this returns~\pythonil{True}.
 
 We now create a second instance, \pythonil{p2}, of the class \pythonil{Point}.
-We assign \pythonil{7} to \pythonil{p2.x} and \pythonil{8} to \pythonil{p2.y} via the \pythonilIdx{\_\_init\_\_} constructor, which is automatically invoked when we write~\pythonil{Point(7, 8)}.
+We assign \pythonil{7} to \pythonil{p2.x} and \pythonil{8} to \pythonil{p2.y} via the \pythonilIdx{\_\_init\_\_} initializer, which is automatically invoked when we write~\pythonil{Point(7, 8)}.
 We can again print the values of these attributes using an \pgls{fstring}.
 While \pythonil{isinstance(p2, Point)} is again \pythonil{True}, \pythonil{isinstance(5, Point)} returns \pythonil{False}.
 
@@ -165,7 +165,7 @@
 So the x\nobreakdashes-~and y\nobreakdashes-attributes of instances of \pythonil{Point} can actually be changed. %
 However, tools like \mypy\ will detect such mistakes and report them~\cite{PEP591}.%
 }
-The x\nobreakdashes-~and y\nobreakdashes-attributes are initialized by the \pythonil{\_\_init\_\_} constructor.
+The x\nobreakdashes-~and y\nobreakdashes-attributes are initialized by the \pythonil{\_\_init\_\_} initializer.
 They are marked with the \pgls{typeHint} \pythonilIdx{Final} and thus changing them is an error.
 In many cases, making objects immutable is a good design pattern.%
 %
@@ -333,7 +333,7 @@
 %
 This is going to be the interface for our new class~\pythonil{KahanSum}, which, in turn, is based on~\cite{K2006AGKBSA}.
 
-In the constructor~\pythonilIdx{\_\_init\_\_}, we create the three attributes~\pythonil{__sum}, \pythonil{__cs}, and \pythonil{__ccs} and initialize them to~\pythonil{0}.
+In the initializer~\pythonilIdx{\_\_init\_\_}, we create the three attributes~\pythonil{__sum}, \pythonil{__cs}, and \pythonil{__ccs} and initialize them to~\pythonil{0}.
 These names are directly taken from \cref{algo:kahanSum}.
 Notice the double leading underscores in front of the names.%
 %

text/main/classes/inheritance/inheritance.tex

@@ -65,10 +65,10 @@
 
 In \cref{lst:classes:circle}, we define the class\pythonIdx{class}~\pythonil{Circle}.
 By writing \pythonil{class Circle(Shape)}\pythonIdx{class}, we declare it as a subclass\pythonIdx{class} of \pythonil{Shape}.
-Its constructor \pythonilIdx{\_\_init\_\_}, we supply two parameters, \pythonil{center}, which is an instance of our class \pythonil{Point} from \cref{lst:classes:point}, and \pythonil{radius}, which can either be an \pythonil{int} or a \pythonil{float}.
-The constructor first checks if \pythonil{radius} is a finite and positive number.
+Its initializer \pythonilIdx{\_\_init\_\_}, we supply two parameters, \pythonil{center}, which is an instance of our class \pythonil{Point} from \cref{lst:classes:point}, and \pythonil{radius}, which can either be an \pythonil{int} or a \pythonil{float}.
+The initializer first checks if \pythonil{radius} is a finite and positive number.
 Otherwise, it raises\pythonIdx{raise} a \pythonilIdx{ValueError}.
-The constructor of the class\pythonIdx{class}~\pythonil{Point} already ensures that both coordinates of \pythonil{point} will be finite.
+The initializer of the class\pythonIdx{class}~\pythonil{Point} already ensures that both coordinates of \pythonil{point} will be finite.
 This ensures that we indeed create valid circles.
 We store \pythonil{center} and \pythonil{radius} in two attributes of the same names.
 We annotate them with the \pgls{typeHint} \pythonilIdx{Final}, which means that they should not be changed after the object is constructed.
@@ -118,7 +118,7 @@
 We now implement them as classes \pythonil{Rectangle} and \pythonil{Triangle} in \cref{lst:classes:rectangle,lst:classes:triangle}, respectively, which both are subclasses of~\pythonil{Polygon}.
 
 A rectangle can be defined using its bottom-left and top-right corner point.
-In the constructor \pythonilIdx{\_\_init\_\_} of the class \pythonil{Rectangle}, we pass in two points~\pythonil{p1} and~\pythonil{p2}.
+In the initializer \pythonilIdx{\_\_init\_\_} of the class \pythonil{Rectangle}, we pass in two points~\pythonil{p1} and~\pythonil{p2}.
 We raise\pythonIdx{raise} a \pythonilIdx{ValueError} if these would form an empty rectangle.
 Otherwise, we store the minimum x\nobreakdashes-~and y\nobreakdashes-coordinate in the bottom-left point attribute~\pythonil{p1} and the maximum x\nobreakdashes-~and y\nobreakdashes-coordinate in the attribute~\pythonil{p2}, marking the top-right corner of our rectangle.