Skip to content

Commit 7632c0b

Browse files
committed
Fix docstring for escape_fragment
1 parent 7d594a1 commit 7632c0b

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

lib/elixir/lib/io/ansi.ex

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -165,10 +165,10 @@ defmodule IO.ANSI do
165165
end
166166

167167
@doc %B"""
168-
Escapes a string coverting named ANSI sequences into actual ANSI codes.
168+
Escapes a string by converting named ANSI sequences into actual ANSI codes.
169169
170-
The format for referring sequences is `%{red}` and `%{red,bright}` (for
171-
multiple sequences)
170+
The format for referring to sequences is `%{red}` and `%{red,bright}` (for
171+
multiple sequences).
172172
173173
An optional boolean parameter can be passed to enable or disable
174174
emitting actual ANSI codes. When false, no ANSI codes will emitted.
@@ -177,8 +177,10 @@ defmodule IO.ANSI do
177177
178178
## Example
179179
180-
iex> IO.ANSI.escape("Hello %{red,bright,green}yes")
180+
iex> IO.ANSI.escape_fragment("Hello %{red,bright,green}yes")
181181
"Hello \e[31m\e[1m\e[32myes\e[0m"
182+
iex> IO.ANSI.escape_fragment("%{reset}bye")
183+
"\e[0mbye"
182184
183185
"""
184186
@spec escape_fragment(String.t, emit :: boolean) :: String.t

0 commit comments

Comments
 (0)