Project

General

Profile

Actions

Bug #18680

closed

The documentation for File::Stat#ctime (for example) says: stat.ctime -> aTime

Added by pedz (Perry Smith) over 2 years ago. Updated over 2 years ago.

Status:
Closed
Assignee:
-
Target version:
-
ruby -v:
3.1.1 but it is in the latest git repo
[ruby-core:108177]

Description

I think it returns Time (not aTime). This is true for three of the four "time" methods.

I would not mind making a pull request if this would be helpful.

Updated by mame (Yusuke Endoh) over 2 years ago

I guess that "aTime" means "a Time" or "an instance of Time". There is no strict rule for writing rdoc AFAIK, but I don't think it is very common to write a class constant name to represent a return instance type. I wonder if -> time is good.

Updated by pedz (Perry Smith) over 2 years ago

Yea. The #atime method has "-> time" ... whatever is decided, the four methods: #atime, #ctime, #mtime, and #birthtime should all have the same doc.

Actions #3

Updated by nobu (Nobuyoshi Nakada) over 2 years ago

  • Status changed from Open to Closed

Applied in changeset git|b0666d64176457786c854c12c79f7beae392bee0.


[DOC] Use consistent terms [Bug #18680]

Actions

Also available in: Atom PDF

Like0
Like0Like0Like0