Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
preciz committed Jul 13, 2024
1 parent f593f1b commit a7ea542
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions lib/tmp.ex
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,13 @@ defmodule Tmp do
## Options
* `:base_dir` - The directory where `:dirname` is going to be created.
Defaults to `System.tmp_dir()`.
* `:base_dir` - The directory where the temporary directory will be created.
Defaults to `System.tmp_dir()`. This directory serves as the parent
directory and won't be removed when the function returns. Only the
newly created temporary directory within `:base_dir` will be cleaned up.
* `:prefix` - Prefix the directory name
* `:prefix` - A string to prefix the temporary directory name. This can be
useful for identifying the purpose or origin of the temporary directory.
* `:timeout` - How long the function is allowed to run before the
GenServer call terminates, defaults to :infinity
Expand Down

0 comments on commit a7ea542

Please sign in to comment.