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.

Sign up for GitHub

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

Fix documentation missing closing backticks #115

Merged
merged 1 commit into from
Oct 31, 2022
Merged

Fix documentation missing closing backticks #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions lib/csv.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ defmodule CSV do
* `:validate_row_length` – When set to `true`, will take the first row of
the csv or its headers and validate that following rows are of the same
length. Defaults to `false`.
* `:unescape_formulas – When set to `true`, will remove formula escaping
* `:unescape_formulas` – When set to `true`, will remove formula escaping
inserted to prevent [CSV Injection](https://owasp.org/www-community/attacks/CSV_Injection).

## Examples
Expand Down Expand Up @@ -157,7 +157,7 @@ defmodule CSV do
* `:validate_row_length` – When set to `true`, will take the first row of
the csv or its headers and validate that following rows are of the same
length. Will raise an error if validation fails. Defaults to `false`.
* `:unescape_formulas – When set to `true`, will remove formula escaping
* `:unescape_formulas` – When set to `true`, will remove formula escaping
inserted to prevent [CSV Injection](https://owasp.org/www-community/attacks/CSV_Injection).

## Examples
Expand Down Expand Up @@ -221,8 +221,8 @@ defmodule CSV do
[[\"a\", \"b\"], [\"c\", \"d\"]]

Replace invalid codepoints:
iex> \"../test/fixtures/broken-encoding.csv\"

iex> "../test/fixtures/broken-encoding.csv"
...> |> Path.expand(__DIR__)
...> |> File.stream!()
...> |> CSV.decode!(field_transform: fn field ->
Expand All @@ -236,7 +236,7 @@ defmodule CSV do
...> end
...> end)
...> |> Enum.take(2)
[[\"a\", \"b\", \"c\", \"?_?\"], [\"ಠ_ಠ\"]]
[["a", "b", "c", "?_?"], ["ಠ_ಠ"]]

"""

Expand Down
2 changes: 1 addition & 1 deletion lib/csv/decoding/parser.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ defmodule CSV.Decoding.Parser do
each field and can apply transformations. Defaults to identity function.
This function will get called for every field and therefore should return
quickly.
* `:unescape_formulas – When set to `true`, will remove formula escaping
* `:unescape_formulas` – When set to `true`, will remove formula escaping
inserted to prevent [CSV Injection](https://owasp.org/www-community/attacks/CSV_Injection).

## Examples
Expand Down