what3words / w3w-python-wrapper

Python wrapper for the what3words API
https://docs.what3words.com/api/v3/
MIT License
78 stars 14 forks source link

Issues in type hints in the circles class #13

Closed Joshuah143 closed 1 month ago

Joshuah143 commented 3 years ago

This code (line 343 in what3words.py ):

"""
    Constructor
    Params
    ------
    :param sw: the coordinates of the southwest corner
    :param ne: the coordinates of the northeast corner
"""

includes params for sw and ne, despite the fact that those don't exist at all. This makes the code hard to read and understand. It is also unclear as to if you could use an instance of the Coordinates class to fille the first positional argument.

Maybe rewrite this little piece for clearity.

ManuCiao commented 1 month ago

this will be updated with the new upcoming release @Joshuah143