From d8d38359bf5ef30648e8ce7f906edc058fbe0830 Mon Sep 17 00:00:00 2001 From: Aleksei Matiushkin Date: Mon, 29 Jul 2024 13:34:32 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Andrea Leopardi --- lib/nimble_ownership.ex | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/nimble_ownership.ex b/lib/nimble_ownership.ex index 6ae563b..b07c703 100644 --- a/lib/nimble_ownership.ex +++ b/lib/nimble_ownership.ex @@ -153,10 +153,10 @@ defmodule NimbleOwnership do If the process is not yet started at the moment of allowance definition, it might be allowed as a function, assuming at the moment of invocation it would have been started. - If the function cannot be resolved to a pid during invocation, the expectation will not succeed. + If the function cannot be resolved to a PID during invocation, the expectation will not succeed. - The function might return a `t:pid/0` or a list of `t:pid/0`s, the latter might be helpful - if one needs to allow a pool of unnamed workers. + The function might return a `t:pid/0` or a list of `t:pid/0`s. A list might be helpful + if one needs to allow multiple PIDs that resolve from a single term, such as the list of workers in a pool. ## Examples @@ -170,8 +170,8 @@ defmodule NimbleOwnership do {:ok, self()} """ - @spec allow(server(), pid(), pid() | (-> pid()) | (-> [pid()]), key()) :: - :ok | {:error, Error.t()} + @spec allow(server(), pid(), pid() | (-> resolved_pid)), key()) :: + :ok | {:error, Error.t()} when resolved_pid: pid() | [pids()] def allow(ownership_server, pid_with_access, pid_to_allow, key, timeout \\ 5000) when is_pid(pid_with_access) and (is_pid(pid_to_allow) or is_function(pid_to_allow, 0)) and is_timeout(timeout) do