PaperPi
PaperPi copied to clipboard
Updates to Documentation Builder
Module/Plugin Documentation builder
Issue to be resolved
- [ ] Documentation builder pulls new JSON config into sample configuration
- [x] rethink how docstrings and user-facing functions are pulled see #140
- [x] 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"