doc update

This commit is contained in:
Will McGugan
2022-08-24 15:24:04 +01:00
parent c0a631ac49
commit f4d5ebb37f
4 changed files with 6 additions and 8 deletions

View File

@@ -357,12 +357,13 @@ class Region(NamedTuple):
@property
def column_span(self) -> tuple[int, int]:
"""Get the start and end column (x coord).
"""Get the start and end columns (x coord).
The end value is exclusive.
Returns:
tuple[int, int]: Pair of x coordinates (column numbers).
"""
return (self.x, self.x + self.width)
@@ -374,6 +375,7 @@ class Region(NamedTuple):
Returns:
tuple[int, int]: Pair of y coordinates (line numbers).
"""
return (self.y, self.y + self.height)
@@ -402,7 +404,7 @@ class Region(NamedTuple):
"""Get the area within the region.
Returns:
int: area.
int: Area covered by this region.
"""
return self.width * self.height