Documentation for Pathname
I've added a documentation patch for Pathname.
- ext/pathname/lib/pathname.rb: Documentation for Pathname.
- ext/pathname/pathname.c: ditto. [Bug #6947]
#1 [ruby-core:47359] Updated by Eric Hodel over 3 years ago
I think there is too much "actually", just "It doesn't access the filesystem" is sufficient.
For freeze, taint and untaint I think "Freezes this Pathname", "Taints this Pathname", "Untaints this Pathname" is a better description.
I think all the "This method has been available since" can be removed since they all predate 1.8.7.
I think the first sentence of the Pathname class comment could be improved. How about "A Pathname represents the name of a file on the filesystem, but not the file itself."
#2 [ruby-core:47364] Updated by Zachary Scott over 3 years ago
Thanks for feedback, much appreciated.
I'll upload a patch with your changes, probably this evening.
One thing I might change is the Pathname intro, since a Pathname can represent a file or a directory:
"Pathname represents the name of a file or directory on the filesystem, but not the file itself."
Not sure if you meant "A Pathname represents ..", I kinda like just "Pathname represents .." better.
#7 Updated by Zachary Scott over 3 years ago
- Status changed from Open to Closed
- % Done changed from 0 to 100