Skip to content

Commit 44bb9c4

Browse files
committed
Add missing doc string
1 parent 9216ef6 commit 44bb9c4

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

server/lib/field_hub/file_store.ex

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,18 @@ defmodule FieldHub.FileStore do
179179
result
180180
end
181181

182+
@doc """
183+
Copy a file into the specified project's directory.
184+
185+
__Parameters__
186+
187+
- `uuid` the uuid for the file (will be used as its file_name).
188+
- `project_identifier` the project's name.
189+
- `file_variant` a valid file variant, one of `#{inspect(@valid_file_variants)}`.
190+
- `input_path` path to the source file to be copied.
191+
192+
Returns `:ok` on success or `{:error, posix}` on failure.
193+
"""
182194
def store_by_moving(uuid, project_identifier, file_variant, input_path) do
183195
directory = get_variant_directory(project_identifier, file_variant)
184196

0 commit comments

Comments
 (0)