docs(update docs and comments)

ckochx · Aug 23, 2022 · b0778fe · b0778fe
1 parent f2dc801
commit b0778fe
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/lib/ex_factor/traces.ex b/lib/ex_factor/traces.ex
@@ -1,6 +1,7 @@
 defmodule ExFactor.Traces do
   def setup do
-    Code.compiler_options(debug_info: true, parser_options: [columns: true, token_metadata: true])
+    Code.compiler_options(warnings_as_errors: false, debug_info: true, parser_options: [columns: true, token_metadata: true])
+
     ExFactor.Server = Code.ensure_loaded!(ExFactor.Server)
     ExFactor.Tracer = Code.ensure_loaded!(ExFactor.Tracer)
 

diff --git a/mix.exs b/mix.exs
@@ -1,3 +1,4 @@
+# Compile Exfactor.Tracer so the compilation tracer is available when it's needed
 Code.compile_file("support/tracer.ex")
 
 defmodule ExFactor.MixProject do

diff --git a/support/trace_task.ex b/support/trace_task.ex
@@ -1,6 +1,7 @@
 defmodule Mix.Tasks.ExFactorRunner do
   @moduledoc """
-  In order to run ExFactor on ExFactor, we need to make some files available "outside of" ExFactor, or more precisely along side of ExFactor.
+  In order to run ExFactor on ExFactor, we need to make some files available "outside of"
+  ExFactor, or more precisely along side of ExFactor.
 
   We need to have a process running during compilation that can run the `ExFactor.Server` Agent.
   Additionally we need the setup from `ExFactor.Traces`, we could replicate this here, but why
@@ -14,8 +15,6 @@ defmodule Mix.Tasks.ExFactorRunner do
       Mix.raise("Elixir v1.13+ is required!")
     end
 
-    Code.compiler_options(debug_info: true, parser_options: [columns: true, token_metadata: true])
-
     Code.compile_file("./lib/ex_factor/server.ex", File.cwd!())
     :timer.sleep(20)