increase uploader behaviour documentation accuracy.

2018-08-30 09:20:29 -03:00 · 2018-08-30 09:20:29 -03:00 · adffad5502
parent af01f0196a
commit adffad5502
1 changed files with 3 additions and 1 deletions
--- 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(),