Code and doc formatting fixes

Author: alco

lib/elixir/lib/io/ansi.ex

@@ -178,7 +178,7 @@ defmodule IO.ANSI do
   ## Example
 
     iex> IO.ANSI.escape_fragment("Hello %{red,bright,green}yes")
-    "Hello \e[31m\e[1m\e[32myes\e[0m"
+    "Hello \e[31m\e[1m\e[32myes"
     iex> IO.ANSI.escape_fragment("%{reset}bye")
     "\e[0mbye"
 

lib/iex/lib/iex/introspection.ex

@@ -10,6 +10,8 @@ defmodule IEx.Introspection do
         case module.__info__(:moduledoc) do
           { _, binary } when is_binary(binary) ->
             IO.puts IEx.color(:info, "# #{inspect module}\n")
+            # We use fragments here so that escape sequences in `binary` are
+            # treated literally and don't get converted to ANSI escapes.
             IO.write IEx.color_fragment(:info) <> binary <> IEx.color_reset()
           { _, _ } ->
             IO.puts IEx.color(:error, "No docs for #{inspect module} have been found")
@@ -148,6 +150,8 @@ defmodule IEx.Introspection do
   defp print_doc({ { fun, _ }, _line, kind, args, doc }) do
     args = Enum.map_join(args, ", ", print_doc_arg(&1))
     IO.puts IEx.color(:info, "* #{kind} #{fun}(#{args})\n")
+    # We use fragments here so that escape sequences in `doc` are
+    # treated literally and don't get converted to ANSI escapes.
     if doc, do: IO.write IEx.color_fragment(:info) <> doc <> IEx.color_reset()
   end
 

lib/iex/lib/iex/options.ex

@@ -1,6 +1,6 @@
 defmodule IEx.Options do
   @moduledoc """
-  Provides an interface for changing options of the running IEx session.
+  Provides an interface for adjusting options of the running IEx session.
   """
 
   @supported_options [
@@ -12,8 +12,9 @@ defmodule IEx.Options do
         The value is a keyword list that should have any of the following keys
         specified. If any of the keys is omitted, that color is not changed.
 
-          * enabled     -- boolean value that allows to switch the colors
+          * enabled     -- boolean value that allows for switching the coloring
                            on and off
+
           * eval_result -- color for an expression's resulting value
           * error       -- color for error messages
           * info        -- color for various informational messages
@@ -43,15 +44,15 @@ defmodule IEx.Options do
   end
 
   def get(name) do
-    raise ArgumentError, message: "Unknown IEx option #{inspect name}"
+    raise_option(name)
   end
 
   @doc """
-  Sets the value of the option `name` to `value`.
+  Sets the value for the option `name` to `value`.
 
-  Returns option's previous value if in the case of success.
+  Returns option's previous value in the case of success.
 
-  Raises if name is not a known option or if the value is invalid.
+  Raises if `name` is not a known option or if the value is invalid.
   """
   def set(name, value)
 
@@ -63,7 +64,7 @@ defmodule IEx.Options do
   end
 
   def set(:colors, _) do
-    raise ArgumentError, message: "Expected colors to be a keyword list"
+    raise_value
   end
 
   def set(:inspect, opts) when is_list(opts) do
@@ -73,25 +74,26 @@ defmodule IEx.Options do
   end
 
   def set(:inspect, _) do
-    raise ArgumentError, message: "Expected opts to be a keyword list"
+    raise_value
   end
 
   def set(name, _) do
-    raise ArgumentError, message: "Unknown IEx option #{inspect name}"
+    raise_option(name)
   end
 
   @doc """
-  Returns a string with the option's description.
+  Returns a string with the option's description. Raises if `name` is not a
+  known option.
   """
   def help(name) do
     case @supported_options[name] do
       kv when is_list(kv) -> kv[:doc]
-      nil -> :bad_option
+      nil -> raise_option(name)
     end
   end
 
   @doc """
-  Same as `help/1` but instead of returning a string, prints it to the console.
+  Same as `help/1` but instead of returning a string, prints it.
   """
   def print_help(name) do
     IO.write help(name)
@@ -103,4 +105,12 @@ defmodule IEx.Options do
   def list() do
     Enum.map @supported_options, fn {k, _} -> k end
   end
+
+  defp raise_option(name) do
+    raise ArgumentError, message: "Unknown IEx option #{inspect name}"
+  end
+
+  defp raise_value do
+    raise ArgumentError, message: "Expected the value to be a keyword list"
+  end
 end