Skip to content

Commit

Permalink
docs: clarify prose
Browse files Browse the repository at this point in the history
  • Loading branch information
ckoch-cars committed Jul 20, 2022
1 parent 67a43e0 commit 50f20fb
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
9 changes: 5 additions & 4 deletions lib/ex_factor.ex
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion lib/ex_factor/remover.ex
Original file line number Diff line number Diff line change
Expand Up @@ -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.
#
"""
Expand Down

0 comments on commit 50f20fb

Please sign in to comment.