docs: clarify prose

ckochx · Jul 20, 2022 · 50f20fb · 50f20fb
1 parent 67a43e0
commit 50f20fb
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/lib/ex_factor.ex b/lib/ex_factor.ex
@@ -2,11 +2,12 @@ defmodule ExFactor do
   @moduledoc """
   `ExFactor` is a refactoring helper.
 
-  By identifying a Module, function name, and arity, it will identify all non-test usages
-  and extract them to a new Module.
+  By identifying a source module, function name, and arity, it will identify all non-test usages
+  and extract them to the target module.
 
-  If the Module exists, it adds the function to the end of the file and change all calls to the
-  new module's name.
+  If the target module exists, it adds the function to the end of the file and changes all calls to the
+  new module namespace. Otherwise ExFactor will create the target module at the target_path or
+  at a (resonably) expected location by the module namespace
   """
 
   _docp = "results struct"

diff --git a/lib/ex_factor/remover.ex b/lib/ex_factor/remover.ex
@@ -66,7 +66,7 @@ defmodule ExFactor.Remover do
     #
     # Function: #{name}/#{arity} removed by ExFactor
     # ExFactor only removes the function itself
-    # Other artifacts, including docs, test references, and module-level comments
+    # Other artifacts such as test references and module-level comments
     # may remain for you to remove manually.
     #
     """