[DOC] require inside each method on Dir

(#31)
ruby · Feb 25, 2024 · a1ec977 · a1ec977
1 parent f505e3f
commit a1ec977
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/lib/tmpdir.rb b/lib/tmpdir.rb
@@ -22,6 +22,9 @@ class Dir
 
   ##
   # Returns the operating system's temporary file path.
+  #
+  #   require 'tmpdir'
+  #   Dir.tmpdir # => "/tmp"
 
   def self.tmpdir
     ['TMPDIR', 'TMP', 'TEMP', ['system temporary path', SYSTMPDIR], ['/tmp']*2, ['.']*2].find do |name, dir|
@@ -45,6 +48,11 @@ def self.tmpdir
 
   # Dir.mktmpdir creates a temporary directory.
   #
+  #   require 'tmpdir'
+  #   Dir.mktmpdir {|dir|
+  #     # use the directory
+  #   }
+  #
   # The directory is created with 0700 permission.
   # Application should not change the permission to make the temporary directory accessible from other users.
   #