Skip to content

Commit

Permalink
docs: extra docstring info for api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Feb 11, 2025
1 parent f762da5 commit f794d05
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion pg_nearest_city/base_nearest_city.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ class DbConfig:
"""Database config for Postgres.
Allows overriding values via constructor parameters, fallback to env vars.
Args:
dbname(str): Database name.
user(str): Database user.
password(str): Database password.
host(str): Database host.
port(str): Database port.
"""

dbname: Optional[str] = None
Expand Down Expand Up @@ -49,7 +57,14 @@ def get_connection_string(self) -> str:

@dataclass
class Location:
"""A location object for JSON serialisation."""
"""A location object for JSON serialisation.
Args:
city(str): The city.
country(str): The country.
lat(str): Latitude.
lon(str): Longitude.
"""

city: str
country: str
Expand Down

0 comments on commit f794d05

Please sign in to comment.