search

ropensci / PostcodesioR

API wrapper around postcodes.io - free UK postcode lookup and geocoder
https://docs.ropensci.org/PostcodesioR
39 stars 7 forks source link

Help vignette for bulk_postcode_lookup is inaccurate #15

Closed dave-lovell closed 2 years ago

dave-lovell commented 3 years ago

The help vignette for bulk_postcode_lookup() states that argument postcodes 'Accepts a list of postcodes'. This is untrue - I've just spent 15 minutes working out that it accepts a list of length one, whose sole element is a character vector of postcodes. 

## This will work:
bulk_postcode_lookup( list( postcodes = c("PR3 0SG", "M45 6GN", "EX165BL")))

## This will not work:
bulk_postcode_lookup( list("PR3 0SG", "M45 6GN", "EX165BL"))

The documentation (with the exception of the examples) implies the latter is the correct syntax.

I'm not sure why the character vector needs to be wrapped in a list, but I'm treating this as a documentation error rather than a missing feature.

erykwalczak commented 3 years ago

Thanks for raising the issue. Will look into this over the weekend.

erykwalczak commented 2 years ago

Fixed https://github.com/ropensci/PostcodesioR/commit/0077c0a19062c82572b4129ecf4def6dca5416ad