[Patches] [ python-Patches-870287 ] Fix docstring for posixpath.getctime

[SourceForge.net]

Patches item #870287, was opened at 2004-01-04 18:22
Message generated for change (Comment added) made by quiver
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=305470&aid=870287&group_id=5470

Category: Documentation
Group: Python 2.3
Status: Open
Resolution: None
Priority: 5
Submitted By: Gerrit Holl (gerrit)
Assigned to: Nobody/Anonymous (nobody)
Summary: Fix docstring for posixpath.getctime

Initial Comment:
(not sure whether this is "Library" or "Documentation")

The docstring of posixpath.getctime calls ctime the
"creation time". This is incorrect, because it is the
"change time". The library documentation is correct
here. This patch fixes the docstring.

----------------------------------------------------------------------

Comment By: George Yoshida (quiver)
Date: 2004-01-18 16:12

Message:
Logged In: YES 
user_id=671362

Yes, your're right. The library document of os.path.ctime was 
fixed, but the docstring of posixpath.py has been left 
unchanged.
So I'm +1 for applying this patch.

I've noticed that there are still several places where the 
definition of ctime is not fixed. For example, stat.st_ctime and 
os.stat.

http://www.python.org/doc/current/lib/module-stat.html
> ST_CTIME : Time of last status change (see manual pages 
for details). 
http://www.python.org/doc/current/lib/os-file-dir.html
> st_ctime (time of most recent content modification or 
metadata change). 

In my opinion, these two also need to be corrected.

----------------------------------------------------------------------

Comment By: Gerrit Holl (gerrit)
Date: 2004-01-17 23:55

Message:
Logged In: YES 
user_id=13298

The docstring is a different issue: The standard library
needs to be accurate for all platforms, whereas each
platform has it's own implementation of os.path.getctime.
Hence, it's possible to give each platform it's own
docstring for os.path.getctime, so that
posixpath.getctime.__doc__ != ntpath.getctime.__doc__. Is
this it a good thing to have different docstrings? If so,
I'd say that each platform documents for it's own getctime
what ctime means. If not, I'd say we copy the standard
library documentation.


----------------------------------------------------------------------

Comment By: George Yoshida (quiver)
Date: 2004-01-12 13:11

Message:
Logged In: YES 
user_id=671362

> IIRC, it is creation time on some platforms and is the
> change time on others.

This was discussed before.

[ 827902 ] ctime is not creation time
http://www.python.org/sf/827902



----------------------------------------------------------------------

Comment By: Raymond Hettinger (rhettinger)
Date: 2004-01-12 08:32

Message:
Logged In: YES 
user_id=80475

IIRC, it is creation time on some platforms and is the
change time on others.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=305470&aid=870287&group_id=5470