Project

General

Profile

Bug #15411

Enhance Tempfile docs

Added by zverok (Victor Shepelev) 9 months ago. Updated 9 months ago.

Status:
Closed
Priority:
Normal
Assignee:
-
Target version:
-
[ruby-core:90525]

Description

Several small style enhancements + I don't know why the "fake" docs for ::new were done this way, but they hid the mode: keyword argument, which once cost me several dozens of minutes to investigate.

Docs currently insist on this call-sequence:

new(basename = "", [tmpdir = Dir.tmpdir], [options])

...insisiting that it will pass all the options to File.new. So, when I wanted to pass mode for File, and ... well, it haven't ended well :)

So, I believe that it is better to represent actual call-sequence in the docs, and mention mode quirks.


Files

tempfile-docs.patch (2.71 KB) tempfile-docs.patch zverok (Victor Shepelev), 12/13/2018 10:44 PM

Associated revisions

Revision 13fd78c2
Added by nobu (Nobuyoshi Nakada) 9 months ago

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

Revision 66415
Added by nobu (Nobuyoshi Nakada) 9 months ago

Enhance Tempfile docs [ci skip]

[ruby-core:90525] [Bug #15411]

From: zverok (Victor Shepelev) zverok.offline@gmail.com

Revision 66415
Added by nobu (Nobuyoshi Nakada) 9 months ago

Enhance Tempfile docs [ci skip]

[ruby-core:90525] [Bug #15411]

From: zverok (Victor Shepelev) zverok.offline@gmail.com

History

#1

Updated by nobu (Nobuyoshi Nakada) 9 months ago

  • Status changed from Open to Closed

Applied in changeset trunk|r66415.


Enhance Tempfile docs [ci skip]

[ruby-core:90525] [Bug #15411]

From: zverok (Victor Shepelev) zverok.offline@gmail.com

Also available in: Atom PDF