From 40993b35ec311a44a596cadb7f6eb4241d5c01e4 Mon Sep 17 00:00:00 2001 From: Mario Uher Date: Fri, 3 May 2024 19:54:36 +0200 Subject: [PATCH] Improve documentation slightly --- lib/tracee.ex | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/lib/tracee.ex b/lib/tracee.ex index 5d402d7..8b2bcd2 100644 --- a/lib/tracee.ex +++ b/lib/tracee.ex @@ -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