Fix documentation.

This commit is contained in:
Sergey Vartanov 2022-07-04 03:34:47 +03:00
parent ac79e6883a
commit af5ad8057d
3 changed files with 13 additions and 3 deletions

View file

@ -168,6 +168,11 @@ class Building(Figure):
def draw_walls(svg, building: Building, segment, height, shift_1, shift_2):
"""
Draw walls for buildings as a quadrangle.
Color of the wall is based on illumination.
"""
fill: str
if building.is_construction:
color_part: float = segment.angle * 0.2

View file

@ -65,6 +65,8 @@ class RoadPart:
scale: float,
) -> None:
"""
Initialize road part with two end points.
:param point_1: start point of the road part
:param point_2: end point of the road part
:param lanes: lane specification
@ -282,8 +284,9 @@ class RoadPart:
class Intersection:
"""
An intersection of the roads, that is described by its parts. All first
points of the road parts should be the same.
An intersection of the roads, that is described by its parts.
All first points of the road parts should be the same.
"""
def __init__(self, parts: list[RoadPart]) -> None:
@ -610,6 +613,8 @@ def get_curve_points(
is_end: bool,
) -> list[np.ndarray]:
"""
TODO: add description.
:param road: road segment
:param center: road intersection point
:param road_end: end point of the road segment

View file

@ -192,7 +192,7 @@ def test_vending_machine() -> None:
def test_diving_tower() -> None:
"""
Check that diving towers are rendered as diving towers, not just
freestandging towers.
freestanding towers.
See https://github.com/enzet/map-machine/issues/138
"""