Skip to content

Commit

Permalink
Improve documentation slightly
Browse files Browse the repository at this point in the history
  • Loading branch information
ream88 committed May 3, 2024
1 parent 5db1103 commit 40993b3
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions lib/tracee.ex
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,13 @@ defmodule Tracee do
## Examples
# expect AnotherModule.expensive_fun/0 to be called once
Tracee.expect(AnotherModule, :expensive_fun, 0)
- Expect `AnotherModule.expensive_fun/0` to be called once:
# expect AnotherModule.expensive_fun/1 to be called twice
Tracee.expect(AnotherModule, :expensive_fun, 1, 2)
Tracee.expect(AnotherModule, :expensive_fun, 0)
- Expect `AnotherModule.expensive_fun/1` to be called twice:
Tracee.expect(AnotherModule, :expensive_fun, 1, 2)
"""
@spec expect(module(), atom(), pos_integer(), pos_integer()) :: :ok
Expand Down

0 comments on commit 40993b3

Please sign in to comment.