From 96b40d5184a50057f56744d51e18773d21154167 Mon Sep 17 00:00:00 2001 From: Carla Date: Fri, 13 Nov 2015 16:29:57 +0100 Subject: [PATCH] Update API.md --- doc/API.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/API.md b/doc/API.md index 414a52b..aebaf43 100644 --- a/doc/API.md +++ b/doc/API.md @@ -39,11 +39,11 @@ return type for the functions (Geometry or NULL if not found, with SRID 4326) **WIP** #### Geocoding functions **WIP** -##### Country geocoder functions +##### Country geocoder function +This function provides a country geocoding service by receiving a country name text as parameter and returns a polygon geometry (SRID 4326) for the corresponding country. + ###### geocode_admin0_polygon -* Description: - This function receives a country name and returns a polygon geometry (SRID 4326) for the corresponding input. -* Functions: + * `geocode_admin0_polygon(country_name text)` * **Parameters**: A text parameter with the name of the country to geocode. * **Return type:** `polygon`