Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to Documentation Builder #130

Open
1 of 2 tasks
txoof opened this issue Sep 3, 2023 · 1 comment
Open
1 of 2 tasks

Updates to Documentation Builder #130

txoof opened this issue Sep 3, 2023 · 1 comment
Assignees

Comments

@txoof
Copy link
Owner

txoof commented Sep 3, 2023

Module/Plugin
Documentation builder

Issue to be resolved

@txoof txoof added this to the Web Configurator milestone Sep 3, 2023
@txoof
Copy link
Owner Author

txoof commented Sep 24, 2023

  • clean up doc strings for user facing functions to be more user friendly (see example below)

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"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

No branches or pull requests

1 participant