From 22355dc960de5d797dbe8ad1602a4468eee3647f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Czeka=C5=84ski?= Date: Sun, 10 May 2020 18:03:29 +0200 Subject: [PATCH] Add comments to all methods in UiConsole class --- src/ui/UiConsole.py | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/src/ui/UiConsole.py b/src/ui/UiConsole.py index e7202e6..31c343c 100644 --- a/src/ui/UiConsole.py +++ b/src/ui/UiConsole.py @@ -40,7 +40,11 @@ class UiConsole(UiElement): """ self.addLinesToConsoleAndScrollToDisplayThem([inp]) - def writeConsoleLines(self, startingLineInd=0): + def writeConsoleLines(self, startingLineInd: int = 0): + """ + Displays lines stored in console's list of lines, starting from line with given index. + :param startingLineInd: Line index, which will be written on top of the console. + """ self.image.fill(self.bgColor) if startingLineInd < 0: startingLineInd = 0 @@ -53,6 +57,13 @@ class UiConsole(UiElement): writtenLines += 1 def addLinesToConsole(self, linesToAdd): + """ + Adds lines to console's list of lines. If one line is too long to display, then it is being cut to pieces, + so that it is appropriate size. + + Warning: this method doesn't display given lines, just adds to list of lines. + :param linesToAdd: + """ for line in linesToAdd: self.consoleLines.append(line) self.linesCount += 1 @@ -81,6 +92,10 @@ class UiConsole(UiElement): self.linesImagesCount += 1 def addLinesToConsoleAndScrollToDisplayThem(self, linesToAdd): + """ + Adds given lines to console's list of lines, writes them and scrolls console down to display them. + :param linesToAdd: Lines to add to console's list of lines and to display. + """ self.addLinesToConsole(linesToAdd) ind = 0 if self.linesImagesCount > self.maxLines: