search

dashbitco / nimble_csv

A simple and fast CSV parsing and dumping library for Elixir
https://hexdocs.pm/nimble_csv
772 stars 51 forks source link

parse_string/2 takes option `:headers`, but documentation says option is named `:header` #30

Closed sparta-developers closed 6 years ago

sparta-developers commented 6 years ago

In the documentation, the option argument name claims to be :header: https://github.com/plataformatec/nimble_csv/blob/v0.4.0/lib/nimble_csv.ex#L148

However, the tests and implementation use the option :headers: https://github.com/plataformatec/nimble_csv/blob/v0.4.0/test/nimble_csv_test.exs#L17

It took us a little bit to figure out why the option wasn't working as expected.

josevalim commented 6 years ago

It has been fixed in master but I haven't pushed new docs. I have done that now, thanks!