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

Documentation on :headers option is confusing #40

Closed tonyc closed 5 years ago

tonyc commented 5 years ago

I feel the documentation for the :headers option while parsing is confusing.

It states:

:headers - when false, no longer discard the first row. Defaults to true.

I had to test the option to see exactly how it works, and it seems to be the opposite of what I'd expect -- setting headers: true skips the headers row, and so I'd expect it to be called e.g. skip_headers.

It's easy enough to update the documentation, but what are your thoughts about deprecating :headers and changing it to :skip_headers?