Remove non ansi handling from IO.ANSI.Docs

Author: José Valim

lib/elixir/lib/float.ex

@@ -33,7 +33,7 @@ defmodule Float do
     parse_unsign(binary)
   end
 
-  defp parse_unsign("-" <> binary), do: :error
+  defp parse_unsign("-" <> _), do: :error
   defp parse_unsign(binary) when is_binary(binary) do
     case Integer.parse binary do
       :error -> :error

lib/elixir/lib/io/ansi/docs.ex

@@ -11,42 +11,12 @@ defmodule IO.ANSI.Docs do
                     doc_bold: "bright",
                     doc_underline: "underline" ]
 
-  @shared_print_doc """
-  In addition to the priting string, takes a truth value for whether to use ANSI
-  escape codes, and a keyword list for the printing color settings. Supported
-  keys for the color settings are:
-
-    * `:enabled`         - toggles coloring on and off (true)
-    * `:doc_code`        - code blocks (cyan, bright)
-    * `:doc_inline_code` - inline code (cyan)
-    * `:doc_headings`    - h1 and h2 headings (yellow, bright)
-    * `:doc_title`       - top level heading (reverse, yellow, bright)
-    * `:doc_bold`        - bold text (bright)
-    * `:doc_underline`   - underlined text (underline)
-
-  Values for the color settings are strings with comma-separated attributes.
-  Supported attributes are:
-
-    * Colors:     `black  red  green  yellow  blue  magenta  cyan  white`
-    * Intensity:  `normal  bright`
-    * Decoration: `underline  reverse`
-  """
-
   @doc """
   Prints the head of the documentation (i.e. the function signature).
 
-  #{@shared_print_doc}
+  See `print/3` for docs on the supported options.
   """
-  def print_heading(string, use_ansi // IO.ANSI.terminal?, colors // @default_colors) do
-    if use_ansi do
-      write_doc_heading(string, colors)
-    else
-      IO.puts "* #{string}\n"
-    end
-    dont_display_result
-  end
-
-  defp write_doc_heading(heading, colors) do
+  def print_heading(heading, colors // @default_colors) do
     IO.puts IO.ANSI.reset
     width   = column_width()
     padding = div(width + String.length(heading), 2)
@@ -57,22 +27,32 @@ defmodule IO.ANSI.Docs do
   @doc """
   Prints the documentation body.
 
-  #{@shared_print_doc}
+  In addition to the priting string, takes a truth value for whether to use ANSI
+  escape codes, and a keyword list for the printing color settings. Supported
+  keys for the color settings are:
+
+  * `:enabled`         - toggles coloring on and off (true)
+  * `:doc_code`        - code blocks (cyan, bright)
+  * `:doc_inline_code` - inline code (cyan)
+  * `:doc_headings`    - h1 and h2 headings (yellow, bright)
+  * `:doc_title`       - top level heading (reverse, yellow, bright)
+  * `:doc_bold`        - bold text (bright)
+  * `:doc_underline`   - underlined text (underline)
+
+  Values for the color settings are strings with comma-separated attributes.
+  Supported attributes are:
+
+  * Colors:     `black  red  green  yellow  blue  magenta  cyan  white`
+  * Intensity:  `normal  bright`
+  * Decoration: `underline  reverse`
   """
-  def print(doc, use_ansi // IO.ANSI.terminal?, colors // @default_colors) do
-    if use_ansi do
-      doc
-      |> String.split(["\r\n","\n"], trim: false)
-      |> Enum.map(&String.rstrip/1)
-      |> process("", colors)
-    else
-      IO.puts doc
-    end
-    dont_display_result
+  def print(doc, colors // @default_colors) do
+    doc
+    |> String.split(["\r\n","\n"], trim: false)
+    |> Enum.map(&String.rstrip/1)
+    |> process("", colors)
   end
 
-  defp dont_display_result, do: :"do not show this result in output"
-
   defp process([], _indent, _colors), do: nil
 
   defp process(["# " <> heading | rest], _indent, colors) do

lib/elixir/test/elixir/io/ansi/docs_test.exs

@@ -12,23 +12,16 @@ defmodule IO.ANSI.DocsTest do
             doc_headings: "yellow,bright",
             doc_title: "reverse,yellow,bright" ]
 
-  def format_heading(str, use_ansi // true) do
-    capture_io(fn -> IO.ANSI.Docs.print_heading(str, use_ansi, @colors) end)
-    |> String.strip
+  def format_heading(str) do
+    capture_io(fn -> IO.ANSI.Docs.print_heading(str, @colors) end) |> String.strip
   end
 
-  def format(str, use_ansi // true) do
-    capture_io(fn -> IO.ANSI.Docs.print(str, use_ansi, @colors) end)
-    |> String.strip
+  def format(str) do
+    capture_io(fn -> IO.ANSI.Docs.print(str, @colors) end) |> String.strip
   end
 
-  test "non-ansi heading just uses an asterisk" do
-    result = format_heading("wibble", false)
-    assert result == "* wibble"
-  end
-
-  test "ansi heading is formatted" do
-    result = format_heading("wibble", true)
+  test "heading is formatted" do
+    result = format_heading("wibble")
     assert String.starts_with?(result, "\e[0m\n\e[7m\e[33m\e[1m")
     assert String.ends_with?(result, "\e[0m\n\e[0m")
     assert String.contains?(result, " wibble ")

lib/iex/lib/iex/introspection.ex

@@ -12,10 +12,14 @@ defmodule IEx.Introspection do
         if function_exported?(module, :__info__, 1) do
           case module.__info__(:moduledoc) do
             { _, binary } when is_binary(binary) ->
-              use_ansi = IO.ANSI.terminal?
-              colors = IEx.Options.get(:colors)
-              IO.ANSI.Docs.print_heading(inspect(module), use_ansi, colors)
-              IO.ANSI.Docs.print(binary, use_ansi, colors)
+              if IO.ANSI.terminal? do
+                colors = IEx.Options.get(:colors)
+                IO.ANSI.Docs.print_heading(inspect(module), colors)
+                IO.ANSI.Docs.print(binary, colors)
+              else
+                IO.puts "* #{inspect(module)}\n"
+                IO.puts binary
+              end
             { _, _ } ->
               nodocs(inspect module)
             _ ->
@@ -159,11 +163,18 @@ defmodule IEx.Introspection do
   end
 
   defp print_doc({ { fun, _ }, _line, kind, args, doc }) do
-    args = Enum.map_join(args, ", ", &print_doc_arg(&1))
-    use_ansi = IO.ANSI.terminal?
-    colors = IEx.Options.get(:colors)
-    IO.ANSI.Docs.print_heading("#{kind} #{fun}(#{args})", use_ansi, colors)
-    if doc, do: IO.ANSI.Docs.print(doc, use_ansi, colors)
+    args    = Enum.map_join(args, ", ", &print_doc_arg(&1))
+    heading = "#{kind} #{fun}(#{args})"
+    doc     = doc || ""
+
+    if IO.ANSI.terminal? do
+      colors = IEx.Options.get(:colors)
+      IO.ANSI.Docs.print_heading(heading, colors)
+      IO.ANSI.Docs.print(doc, colors)
+    else
+      IO.puts "* #{heading}\n"
+      IO.puts doc
+    end
   end
 
   defp print_doc_arg({ ://, _, [left, right] }) do