Fix pydocstyle warnings.

map_machine/color.py

@@ -1,6 +1,4 @@
-"""
+"""Color utility."""
-Color utility.
-"""
 from typing import Any
 
 from colour import Color

map_machine/constructor.py

@@ -1,6 +1,4 @@
-"""
+"""Construct Map Machine nodes and ways."""
-Construct Map Machine nodes and ways.
-"""
 import logging
 import sys
 from datetime import datetime

map_machine/doc/__init__.py

@@ -1,3 +1 @@
-"""
+"""Documentation utilities."""
-Documentation utilities.
-"""

map_machine/doc/doc_collections.py

@@ -1,6 +1,4 @@
-"""
+"""Special icon collections for documentation."""
-Special icon collections for documentation.
-"""
 import json
 from dataclasses import dataclass, field
 from pathlib import Path

map_machine/doc/draw_elements.py

@@ -1,6 +1,4 @@
-"""
+"""Draw test nodes, ways, and relations."""
-Draw test nodes, ways, and relations.
-"""
 import logging
 from pathlib import Path
 from typing import Optional

map_machine/doc/icons.py

@@ -1,6 +1,4 @@
-"""
+"""Icon grids for documentation."""
-Icon grids for documentation.
-"""
 from pathlib import Path
 from typing import Iterable
 

map_machine/doc/moire_manager.py

@@ -1,6 +1,4 @@
-"""
+"""Moire markup extension for Map Machine."""
-Moire markup extension for Map Machine.
-"""
 import argparse
 from abc import ABC
 from pathlib import Path

map_machine/doc/preview.py

@@ -1,6 +1,4 @@
-"""
+"""Actions to perform before commit: generate PNG images for documentation."""
-Actions to perform before commit: generate PNG images for documentation.
-"""
 import logging
 import sys
 from pathlib import Path

map_machine/doc/wiki.py

@@ -1,6 +1,4 @@
-"""
+"""Automate OpenStreetMap wiki editing."""
-Automate OpenStreetMap wiki editing.
-"""
 import re
 from pathlib import Path
 from typing import Optional

map_machine/drawing.py

@@ -1,6 +1,4 @@
-"""
+"""Drawing utility."""
-Drawing utility.
-"""
 from dataclasses import dataclass
 from pathlib import Path
 from typing import Optional, Union

map_machine/element/single.py

@@ -1,6 +1,4 @@
-"""
+"""Drawing separate map elements."""
-Drawing separate map elements.
-"""
 import argparse
 import logging
 from pathlib import Path

map_machine/feature/building.py

@@ -1,6 +1,4 @@
-"""
+"""Buildings on the map."""
-Buildings on the map.
-"""
 import numpy as np
 from colour import Color
 from svgwrite import Drawing

map_machine/feature/crater.py

@@ -1,6 +1,4 @@
-"""
+"""Crater on the map."""
-Crater on the map.
-"""
 import numpy as np
 from colour import Color
 from svgwrite import Drawing

map_machine/feature/direction.py

@@ -1,6 +1,4 @@
-"""
+"""Direction tag support."""
-Direction tag support.
-"""
 from typing import Iterator, Optional
 
 import numpy as np

map_machine/feature/road.py

@@ -1,6 +1,4 @@
-"""
+"""WIP: road shape drawing."""
-WIP: road shape drawing.
-"""
 import logging
 from collections import defaultdict
 from dataclasses import dataclass

map_machine/figure.py

@@ -1,6 +1,4 @@
-"""
+"""Figures displayed on the map."""
-Figures displayed on the map.
-"""
 import numpy as np
 
 from map_machine.geometry.flinger import Flinger

map_machine/geometry/boundary_box.py

@@ -1,6 +1,4 @@
-"""
+"""Rectangle that limit space on the map."""
-Rectangle that limit space on the map.
-"""
 import logging
 import re
 from dataclasses import dataclass

map_machine/geometry/flinger.py

@@ -1,6 +1,4 @@
-"""
+"""Geo projection."""
-Geo projection.
-"""
 from typing import Optional
 
 import numpy as np

map_machine/geometry/vector.py

@@ -1,6 +1,4 @@
-"""
+"""Vector utility."""
-Vector utility.
-"""
 import numpy as np
 
 __author__ = "Sergey Vartanov"

map_machine/main.py

@@ -1,6 +1,4 @@
-"""
+"""Map Machine entry point."""
-Map Machine entry point.
-"""
 import argparse
 import logging
 import sys

map_machine/map_configuration.py

@@ -1,6 +1,4 @@
-"""
+"""Map drawing configuration."""
-Map drawing configuration.
-"""
 import argparse
 from dataclasses import dataclass
 from enum import Enum

map_machine/mapcss.py

@@ -1,6 +1,4 @@
-"""
+"""MapCSS scheme creation."""
-MapCSS scheme creation.
-"""
 import argparse
 import logging
 from pathlib import Path

map_machine/mapper.py

@@ -1,6 +1,4 @@
-"""
+"""Simple OpenStreetMap renderer."""
-Simple OpenStreetMap renderer.
-"""
 import argparse
 import logging
 import sys

map_machine/osm/osm_getter.py

@@ -1,6 +1,4 @@
-"""
+"""Getting OpenStreetMap data from the web."""
-Getting OpenStreetMap data from the web.
-"""
 import logging
 import time
 from dataclasses import dataclass

map_machine/osm/osm_reader.py

@@ -1,6 +1,4 @@
-"""
+"""Parse OSM XML file."""
-Parse OSM XML file.
-"""
 import json
 import logging
 import re

map_machine/pictogram/__init__.py

@@ -1,3 +1 @@
-"""
+"""Icons and points."""
-Icons and points.
-"""

map_machine/pictogram/icon.py

@@ -1,6 +1,4 @@
-"""
+"""Extract icons from SVG file."""
-Extract icons from SVG file.
-"""
 import json
 import logging
 import re

map_machine/pictogram/icon_collection.py

@@ -1,6 +1,4 @@
-"""
+"""Icon grid drawing."""
-Icon grid drawing.
-"""
 import logging
 import shutil
 from dataclasses import dataclass

map_machine/pictogram/point.py

@@ -1,6 +1,4 @@
-"""
+"""Point: node representation on the map."""
-Point: node representation on the map.
-"""
 import logging
 from typing import Optional
 

map_machine/scheme.py

@@ -1,6 +1,4 @@
-"""
+"""Map Machine drawing scheme."""
-Map Machine drawing scheme.
-"""
 import logging
 import re
 from dataclasses import dataclass

map_machine/slippy/server.py

@@ -1,6 +1,4 @@
-"""
+"""Map Machine tile server for slippy maps."""
-Map Machine tile server for slippy maps.
-"""
 import argparse
 import logging
 from http.server import HTTPServer, SimpleHTTPRequestHandler

map_machine/text.py

@@ -1,6 +1,4 @@
-"""
+"""OSM address tag processing."""
-OSM address tag processing.
-"""
 from dataclasses import dataclass
 from typing import Any, Optional
 

map_machine/ui/cli.py

@@ -1,6 +1,4 @@
-"""
+"""Command-line user interface."""
-Command-line user interface.
-"""
 import argparse
 
 from map_machine import __version__

map_machine/util.py

@@ -1,6 +1,4 @@
-"""
+"""Utility file."""
-Utility file.
-"""
 from dataclasses import dataclass
 from typing import Any
 

map_machine/workspace.py

@@ -1,6 +1,4 @@
-"""
+"""File and directory path in the project."""
-File and directory path in the project.
-"""
 from pathlib import Path
 
 __author__ = "Sergey Vartanov"