Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update encode_options and decode_options typespecs and docs #118

Merged
merged 1 commit into from
Nov 4, 2022
Merged

update encode_options and decode_options typespecs and docs #118

merged 1 commit into from
Nov 4, 2022

Conversation

joseph-lozano
Copy link
Contributor

This PR addresses
The type definitions for encode_options and decode_options were duplicated across csv.ex, encoder.ex and decoder.ex. This PR unifies the typespecs into csv.ex.

Additionally, it adds Keyword.t() as a type for :headers, as indicated by the README. It also updates the docs for encode/2 to reflect this usage.

Open questions

  • Anything that you wanted to discuss

Checklist

  • - Tests added
  • - Coverage increases or stays the same
  • - Docs updated
  • - Changelog updated

@coveralls
Copy link

coveralls commented Nov 4, 2022

Coverage Status

Coverage increased (+0.5%) to 100.0% when pulling 0a193c3 on joseph-lozano:fix-types-and-docs into b834446 on beatrichartz:main.

@beatrichartz beatrichartz merged commit 2086024 into beatrichartz:main Nov 4, 2022
@beatrichartz
Copy link
Owner

Thanks, this is merged and released in 3.0.3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants