Improve documentation about encoding option #793
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
josevalim
reviewed
Jan 1, 2024
lib/explorer/data_frame.ex
Outdated
| @@ -627,6 +630,7 @@ defmodule Explorer.DataFrame do | |||
| * `:eol_delimiter` - A single character used to represent new lines. (default: `"\n"`) | |||
| * `:backend` - The Explorer backend to use. Defaults to the value returned by `Explorer.Backend.get/0`. | |||
| * `:lazy` - force the results into the lazy version of the current backend. | |||
| * `:encoding` - Encoding to use when reading the file. For now, the only possible values are `utf8` and `utf8-lossy`. The utf8-lossy option means that invalid utf8 values are replaced with � characters. (default: `"utf8"`) | |||
There was a problem hiding this comment.
@philss Should we make them atoms instead of regular strings?
There was a problem hiding this comment.
@josevalim yeah, I think so!
@Jhonatannunessilva there is an example of what we want to do in #770
But if you prefer, we can do in another PR as well :)
There was a problem hiding this comment.
No problem, I can do it in this PR
There was a problem hiding this comment.
As we talked privately, this is going to be changed in another PR :)
josevalim
reviewed
Jan 1, 2024
Co-authored-by: José Valim <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR resolves #791
After this PR:
DataFrame.from_csv/2:
DataFrame.load_csv/2: