txoof / PaperPi

E-Paper display loop with plugins
97 stars 10 forks source link

Updates to Documentation Builder #130

Open txoof opened 1 year ago

txoof commented 1 year ago

Module/Plugin Documentation builder

Issue to be resolved

txoof commented 11 months ago

current

FUNCTION: get_coord
USER FACING HELPER FUNCTION:
    lookup and print the latitude, longitude of a place given as a string:

    usage: --run_plugin_func met_no.get_coord "Horsetooth Reservoir, Fort Collins CO, USA"

    Args:
        place(`str`): "City, Provence, Country

    Returns:
        `tuple`: lat, lon

    Example:
        get_coord("Denver, Colorado, USA")
        get_coord("Bamako, Mali")

___________________________________________________________________________

proposed

get_cord: Find the latitude and longitude for locations on earth from the OSM database

Enter a comma separated place name to return the lat/lon values for a place. 

Examples:
    "Denver, Colorado, USA"
    "Berlin, Germany"
    " Horsetooth Reservoir, Fort Collins Colorado, USA"