From adffad55028a8c43a6f2fcf43376009a43c25cf7 Mon Sep 17 00:00:00 2001 From: Thurloat Date: Thu, 30 Aug 2018 09:20:29 -0300 Subject: [PATCH] increase uploader behaviour documentation accuracy. --- lib/pleroma/uploaders/uploader.ex | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/pleroma/uploaders/uploader.ex b/lib/pleroma/uploaders/uploader.ex index 19bea77dc..b58fc6d71 100644 --- a/lib/pleroma/uploaders/uploader.ex +++ b/lib/pleroma/uploaders/uploader.ex @@ -6,7 +6,9 @@ defmodule Pleroma.Uploaders.Uploader do @doc """ Put a file to the backend. - Returns a `String.t` containing the path of the uploaded file. + Returns `{:ok, String.t } | {:error, String.t} containing the path of the + uploaded file, or error information if the file failed to be saved to the + respective backend. """ @callback put_file( name :: String.t(), -- 2.45.2