Fix sphinx/build_docs warnings for geodesy (#12462)

* updating DIRECTORY.md

* Fix sphinx/build_docs warnings for geodesy/haversine_distance.py

* Improve

---------

Co-authored-by: MaximSmolskiy <MaximSmolskiy@users.noreply.github.com>
This commit is contained in:
Maxim Smolskiy 2024-12-23 15:43:16 +03:00 committed by GitHub
parent 47cd21a110
commit c5e603ae42
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -21,10 +21,11 @@ def haversine_distance(lat1: float, lon1: float, lat2: float, lon2: float) -> fl
computation like Haversine can be handy for shorter range distances. computation like Haversine can be handy for shorter range distances.
Args: Args:
lat1, lon1: latitude and longitude of coordinate 1 * `lat1`, `lon1`: latitude and longitude of coordinate 1
lat2, lon2: latitude and longitude of coordinate 2 * `lat2`, `lon2`: latitude and longitude of coordinate 2
Returns: Returns:
geographical distance between two points in metres geographical distance between two points in metres
>>> from collections import namedtuple >>> from collections import namedtuple
>>> point_2d = namedtuple("point_2d", "lat lon") >>> point_2d = namedtuple("point_2d", "lat lon")
>>> SAN_FRANCISCO = point_2d(37.774856, -122.424227) >>> SAN_FRANCISCO = point_2d(37.774856, -122.424227)