File tree Expand file tree Collapse file tree 1 file changed +6
-4
lines changed Expand file tree Collapse file tree 1 file changed +6
-4
lines changed Original file line number Diff line number Diff line change @@ -165,10 +165,10 @@ defmodule IO.ANSI do
165
165
end
166
166
167
167
@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.
169
169
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).
172
172
173
173
An optional boolean parameter can be passed to enable or disable
174
174
emitting actual ANSI codes. When false, no ANSI codes will emitted.
@@ -177,8 +177,10 @@ defmodule IO.ANSI do
177
177
178
178
## Example
179
179
180
- iex> IO.ANSI.escape ("Hello %{red,bright,green}yes")
180
+ iex> IO.ANSI.escape_fragment ("Hello %{red,bright,green}yes")
181
181
"Hello \e [31m\e [1m\e [32myes\e [0m"
182
+ iex> IO.ANSI.escape_fragment("%{reset}bye")
183
+ "\e [0mbye"
182
184
183
185
"""
184
186
@spec escape_fragment( String. t , emit :: boolean) :: String . t
You can’t perform that action at this time.
0 commit comments