From dcb5e03beef20dd63c06aceb14f3d630441c6fb6 Mon Sep 17 00:00:00 2001 From: May Tusek Date: Fri, 14 Feb 2025 16:47:14 -0800 Subject: [PATCH] Adds some basic documentation. --- test/support/utilities.ex | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/test/support/utilities.ex b/test/support/utilities.ex index 4b969931..0e562620 100644 --- a/test/support/utilities.ex +++ b/test/support/utilities.ex @@ -14,6 +14,13 @@ defmodule Philomena.TestUtilities do end end + @doc """ + Asserts the result of a lambda after at most max_retries times for a truthy value. + + ## Examples + iex> assert_retry(&(false)) + Expected truthy, got false + """ def assert_retry(evaluation_lambda, max_retries \\ 3, timeout_in_ms \\ 1000) when is_function(evaluation_lambda) do assert assert_retry(evaluation_lambda, 0, max_retries, timeout_in_ms)