ipeaGIT / geobr

Easy access to official spatial data sets of Brazil in R and Python
https://ipeagit.github.io/geobr/
789 stars 118 forks source link

Adjustment on README.md #240

Closed ruanstaffuzza closed 3 years ago

ruanstaffuzza commented 3 years ago

Sugiro uma alteração no arquivo README.md para melhor descrever a função lookup_muni.

A descrição dá a entender que seria uma tabela pra quem quer resolver problema com nomes. Só descobri que ela possui a informação dos códigos de mesorregião olhando os issues.

Actual version: "Look up municipality codes by their name, or the other way around"

Suggestion1: "Dictionary of municipality code, names, and regions." Suggestion2: "Look up municipality code, their name and their meso, micro, intermediate and immediate regions, by name or code."

rafapereirabr commented 3 years ago

Essa aqui é a descrição da função no pacote R. Talvez seja o caso de usar a mesma descrição no Python.

#' Look up municipality codes and names
#'
#' @description
#' Input a municipality \strong{name} \emph{or} \strong{code} and get the names
#' and codes of the municipality's corresponding state, meso, micro, intermediate,
#' and immediate regions
#'
ruanstaffuzza commented 3 years ago

A descrição da função no Python é igual a essa do R, que está ótima.

Minha sugestão era para alterar o README, mas concordo que o README não necessita ser tão específico.

Pode ter sido só erro meu de não consultar a documentação direito. Por mim pode fechar o issue.

rafapereirabr commented 3 years ago

Ok.