From 83b74ecaf4db8d442b7c7049aba6152b2c3d60c7 Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Fri, 11 Feb 2022 19:44:49 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=94=20Fix=20docstrings=20for=20certain?= =?UTF-8?q?=20files?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- lihzahrd/fileutils/coordinates.py | 4 ++-- lihzahrd/fileutils/filereader.py | 2 ++ lihzahrd/fileutils/pointers.py | 4 ++++ lihzahrd/fileutils/rect.py | 2 ++ 4 files changed, 10 insertions(+), 2 deletions(-) diff --git a/lihzahrd/fileutils/coordinates.py b/lihzahrd/fileutils/coordinates.py index c4d708b..d0e1c9b 100644 --- a/lihzahrd/fileutils/coordinates.py +++ b/lihzahrd/fileutils/coordinates.py @@ -1,7 +1,7 @@ class Coordinates: - __slots__ = "x", "y" - """A pair of coordinates.""" + + __slots__ = "x", "y" def __init__(self, x, y): self.x = x diff --git a/lihzahrd/fileutils/filereader.py b/lihzahrd/fileutils/filereader.py index 81b407a..92c25c5 100644 --- a/lihzahrd/fileutils/filereader.py +++ b/lihzahrd/fileutils/filereader.py @@ -7,6 +7,8 @@ from .rect import Rect class FileReader: + """Helper class for deserializing a Terraria world file.""" + __slots__ = ("file",) def __init__(self, file: typing.IO): diff --git a/lihzahrd/fileutils/pointers.py b/lihzahrd/fileutils/pointers.py index 402495c..21adb68 100644 --- a/lihzahrd/fileutils/pointers.py +++ b/lihzahrd/fileutils/pointers.py @@ -2,6 +2,10 @@ import typing class Pointers: + """Pointers to the various sections of the Terraria save file. + + All values are in number of bytes from the start.""" + __slots__ = ( "file_format", "world_header", diff --git a/lihzahrd/fileutils/rect.py b/lihzahrd/fileutils/rect.py index 85bd871..1b84681 100644 --- a/lihzahrd/fileutils/rect.py +++ b/lihzahrd/fileutils/rect.py @@ -1,4 +1,6 @@ class Rect: + """Class delimining the bounds of a rectangle.""" + __slots__ = "left", "right", "top", "bottom" def __init__(self, left, right, top, bottom):