Project

General

Profile

Bug #15411

Enhance Tempfile docs

Added by zverok (Victor Shepelev) over 1 year ago. Updated over 1 year 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

Also available in: Atom PDF