diff options
| author | nobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2018-12-16 12:09:08 +0000 |
|---|---|---|
| committer | nobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2018-12-16 12:09:08 +0000 |
| commit | 13fd78c2e15eae8d742811bfe5c07bbf119616ae (patch) | |
| tree | 28a1b0f98c80b60ada704aa86ea2e6e0dfd6abab /lib/tempfile.rb | |
| parent | 3b13bc634f73a9b9cc0602b645048f6448d5ee4c (diff) | |
| download | ruby-13fd78c2e15eae8d742811bfe5c07bbf119616ae.tar.gz | |
Enhance Tempfile docs [ci skip]
[ruby-core:90525] [Bug #15411]
From: zverok (Victor Shepelev) <zverok.offline@gmail.com>
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66415 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/tempfile.rb')
| -rw-r--r-- | lib/tempfile.rb | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/lib/tempfile.rb b/lib/tempfile.rb index 21742371aa..f703709113 100644 --- a/lib/tempfile.rb +++ b/lib/tempfile.rb @@ -47,7 +47,7 @@ require 'tmpdir' # # file = Tempfile.new('foo') # begin -# ...do something with file... +# # ...do something with file... # ensure # file.close # file.unlink # deletes the temp file @@ -79,9 +79,6 @@ require 'tmpdir' # same Tempfile object from multiple threads then you should protect it with a # mutex. class Tempfile < DelegateClass(File) - # call-seq: - # new(basename = "", [tmpdir = Dir.tmpdir], [options]) - # # Creates a temporary file with permissions 0600 (= only readable and # writable by the owner) and opens it with mode "w+". # @@ -114,10 +111,13 @@ class Tempfile < DelegateClass(File) # +File.open+. This is mostly useful for specifying encoding # options, e.g.: # - # Tempfile.new('hello', '/home/aisaka', :encoding => 'ascii-8bit') + # Tempfile.new('hello', '/home/aisaka', encoding: 'ascii-8bit') # # # You can also omit the 'tmpdir' parameter: - # Tempfile.new('hello', :encoding => 'ascii-8bit') + # Tempfile.new('hello', encoding: 'ascii-8bit') + # + # Note: +mode+ keyword argument, as accepted by Tempfile, can only be + # numeric, combination of the modes defined in File::Constants. # # === Exceptions # @@ -174,7 +174,7 @@ class Tempfile < DelegateClass(File) # # file = Tempfile.new('foo') # begin - # ...do something with file... + # # ...do something with file... # ensure # file.close # file.unlink # deletes the temp file @@ -195,7 +195,7 @@ class Tempfile < DelegateClass(File) # file = Tempfile.new('foo') # file.unlink # On Windows this silently fails. # begin - # ... do something with file ... + # # ... do something with file ... # ensure # file.close! # Closes the file handle. If the file wasn't unlinked # # because #unlink failed, then this method will attempt @@ -277,13 +277,13 @@ class Tempfile < DelegateClass(File) # In any case, all arguments (<code>*args</code>) will be passed to Tempfile.new. # # Tempfile.open('foo', '/home/temp') do |f| - # ... do something with f ... + # # ... do something with f ... # end # # # Equivalent: # f = Tempfile.open('foo', '/home/temp') # begin - # ... do something with f ... + # # ... do something with f ... # ensure # f.close # end @@ -321,7 +321,7 @@ end # <code>**options</code>) will be treated as Tempfile.new. # # Tempfile.create('foo', '/home/temp') do |f| -# ... do something with f ... +# # ... do something with f ... # end # def Tempfile.create(basename="", tmpdir=nil, mode: 0, **options) |