Skip to content

Commit

Permalink
document tmpname.dir
Browse files Browse the repository at this point in the history
inch ci doesn't properly handle the module as a whole being marked private
and makes a stink about the documentation. no bad idea to have good docs
for internal api anyway, so just document it
  • Loading branch information
hsitter committed Mar 26, 2018
1 parent 5abebfe commit 61a8970
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions lib/aptly/tmpname.rb
Expand Up @@ -18,6 +18,8 @@
module Aptly
# Helper to generate temporary names
module TmpName
# Generate a random temporary directory name.
# @param prefix [String] arbitrary prefix string to start the name with
# @return [String] temporary directory name (only safe characters)
def self.dir(prefix)
format('%<prefix>s-%<time>s-%<pid>s-%<tid>s-%<rand>s',
Expand Down

0 comments on commit 61a8970

Please sign in to comment.