Skip to content

Update docstrings #60

@Herald-TUOS

Description

@Herald-TUOS

We no longer return GSPGroup from reverse_geocode_gsp method. Update the doc strings accordingly

Geocode/geocode/neso.py

Lines 263 to 284 in 9cb3892

def reverse_geocode_gsp(
self, latlons: List[Tuple[float, float]], version: str, **kwargs
) -> Tuple[List[int], List[List[Dict]]]:
"""
Reverse-geocode latitudes and longitudes to GSP using the 20220314 definitions.
Parameters
----------
`latlons` : list of tuples
A list of tuples containing (latitude, longitude).
`version` : string
`kwargs`: dict
Options to pass to the underlying utilities.reverse_geocode method.
Returns
-------
`results` : list of ints
A list of tuples containing (<GSPs>, <GSPGroup>), aligned with the input *latlons*.
Notes
-----
Return format needs some work, maybe switch to DataFrames in future release.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions