forked from YokaiRick/akkoma
increase uploader behaviour documentation accuracy.
This commit is contained in:
parent
af01f0196a
commit
adffad5502
1 changed files with 3 additions and 1 deletions
|
@ -6,7 +6,9 @@ defmodule Pleroma.Uploaders.Uploader do
|
||||||
@doc """
|
@doc """
|
||||||
Put a file to the backend.
|
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(
|
@callback put_file(
|
||||||
name :: String.t(),
|
name :: String.t(),
|
||||||
|
|
Loading…
Reference in a new issue