Skip to content

Commit

Permalink
Update mockery.ex
Browse files Browse the repository at this point in the history
  • Loading branch information
telnicky authored and amatalai committed Oct 19, 2017
1 parent a485416 commit 74453fc
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions lib/mockery.ex
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@ defmodule Mockery do
@doc """
Function used to prepare module for mocking.
For Mix.env other than :test it returns first argument unchanged.
For Mix.env == :test it creates kind of proxy to oryginal module.
For Mix.env other than :test it returns the first argument unchanged.
For Mix.env == :test it creates a proxy to the original module.
When Mix is missing it assumes that env is :prod
@elixir_module Mockery.of("MyApp.Module")
@erlang_module Mockery.of(:crypto)
It is also possible to pass module in elixir format
It is also possible to pass the module in elixir format
@module Mockery.of(MyApp.Module)
but is not recommended as it creates unnecessary compile-time dependency
but it is not recommended as it creates an unnecessary compile-time dependency
(see `mix xref graph` output for both versions).
"""
@spec of(mod :: atom | String.t, opts :: keyword_opts) ::
Expand Down

0 comments on commit 74453fc

Please sign in to comment.