diff options
| author | Thurloat <thurloat@gmail.com> | 2018-08-30 09:20:29 -0300 |
|---|---|---|
| committer | Thurloat <thurloat@gmail.com> | 2018-08-30 09:20:29 -0300 |
| commit | adffad55028a8c43a6f2fcf43376009a43c25cf7 (patch) | |
| tree | 65c2b673bb2bb1c38d92d608e1f155986066abd4 /lib | |
| parent | af01f0196a43454728f6e0ca8b9b8be208743251 (diff) | |
| download | pleroma-adffad55028a8c43a6f2fcf43376009a43c25cf7.tar.gz | |
increase uploader behaviour documentation accuracy.
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/pleroma/uploaders/uploader.ex | 4 |
1 files changed, 3 insertions, 1 deletions
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(), |