Skip to content

Fix typos in IO documentation #14398

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

Merged
merged 2 commits into from
Apr 5, 2025
Merged

Fix typos in IO documentation #14398

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20c7c37
Update io.ex
swsch Apr 4, 2025
607d66e
Normalize newline characters and update doc syntax
josevalim Apr 5, 2025
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/elixir/lib/io.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ defmodule IO do
non-textual inputs.

* if `line_or_chars` is `:line`, the device is iterated line by line.
CRFL newlines ("\r\n") are automatically normalized to "\n".
CRLF newlines ("\\r\\n") are automatically normalized to "\\n".
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is often achieved by using the ~S sigil rather than manually escaping (you can see we have a lot of @doc ~S in the codebase).


* if `line_or_chars` is `:eof` (since v1.13), the device is iterated until `:eof`.
If the device is already at the end, it returns `:eof` itself.
Expand Down Expand Up @@ -196,7 +196,7 @@ defmodule IO do
non-textual inputs.

* if `line_or_chars` is `:line`, the device is iterated line by line.
CRFL newlines ("\r\n") are automatically normalized to "\n".
CRLF newlines ("\\r\\n") are automatically normalized to "\\n".

* if `line_or_chars` is `:eof` (since v1.13), the device is iterated until `:eof`.
If the device is already at the end, it returns `:eof` itself.
Expand Down Expand Up @@ -612,7 +612,7 @@ defmodule IO do

The `device` is iterated by the given number of characters
or line by line if `:line` is given. In case `:line` is given,
"\r\n" is automatically normalized to "\n".
"\\r\\n" is automatically normalized to "\n".

This reads from the IO as UTF-8. Check out
`IO.binstream/2` to handle the IO as a raw binary.
Expand Down Expand Up @@ -666,8 +666,8 @@ defmodule IO do
and write.

The `device` is iterated by the given number of bytes or line
by line if `:line` is given. In case `:line` is given, "\r\n"
is automatically normalized to "\n". Passing the number of bytes
by line if `:line` is given. In case `:line` is given, "\\r\\n"
is automatically normalized to "\\n". Passing the number of bytes
should be the preferred mode for reading non-textual inputs.

Note that an IO stream has side effects and every time
Expand Down