increase uploader behaviour documentation accuracy.
authorThurloat <thurloat@gmail.com>
Thu, 30 Aug 2018 12:20:29 +0000 (09:20 -0300)
committerThurloat <thurloat@gmail.com>
Thu, 30 Aug 2018 12:20:29 +0000 (09:20 -0300)
lib/pleroma/uploaders/uploader.ex

index 19bea77dcfa41ef0de8692a10258a522cd64e5e3..b58fc6d713d1dfec501922242e7239e175ba4e2a 100644 (file)
@@ -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(),