search

pelias / csv-importer

Import arbitrary data in CSV format to Pelias
MIT License
23 stars 22 forks source link

Documentation : Comments on mandatory fields and their types #77

Closed jossefaz closed 4 years ago

jossefaz commented 4 years ago

Here's the reason for this change :rocket:

It was not clear from the documentation which fields are mandatory and what types are they.

Here's what actually got changed :clap:

After many tests I found usefull to add some quick iverview on fields type and also a comment on the field name which is actually mandatory (if there is no adress field)

So I added those comments ine the README.md file

orangejulius commented 4 years ago

Hi @yossefaz, Thanks for this PR. As you've discovered, while it's technically correct that the name field can be omitted and the CSV importer will still import the records, those records will be effectively useless as they won't show up in most searches.

So this is a great change that should be very helpful.