Bug #6947

Documentation for Pathname

Added by Zachary Scott over 2 years ago. Updated over 2 years ago.

[ruby-core:47354]
Status:Closed
Priority:Normal
Assignee:Zachary Scott
ruby -v:2.0.0 Backport:

Description

I've added a documentation patch for Pathname.

0001-Documentation-for-Pathname.patch Magnifier (30.4 KB) Zachary Scott, 08/29/2012 07:32 AM

0002-Documentation-for-Pathname.patch Magnifier (30.9 KB) Zachary Scott, 08/31/2012 05:48 AM

Associated revisions

Revision 36950
Added by Zachary Scott over 2 years ago

  • ext/pathname/lib/pathname.rb: Documentation for Pathname.
  • ext/pathname/pathname.c: ditto. [Bug #6947]

Revision 36950
Added by Zachary Scott over 2 years ago

  • ext/pathname/lib/pathname.rb: Documentation for Pathname.
  • ext/pathname/pathname.c: ditto. [Bug #6947]

History

#1 Updated by Eric Hodel over 2 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 Updated by Zachary Scott over 2 years ago

Hi Eric!
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.

#3 Updated by Eric Hodel over 2 years ago

"Pathname represents ..." is good

#4 Updated by Zachary Scott over 2 years ago

Hi Eric!
Here's the patch we discussed, see 0002-*-Pathname.patch

Thanks

#5 Updated by Eric Hodel over 2 years ago

This looks good, please commit it.

#6 Updated by Eric Hodel over 2 years ago

  • Assignee changed from Eric Hodel to Zachary Scott

#7 Updated by Zachary Scott over 2 years ago

  • Status changed from Open to Closed
  • % Done changed from 0 to 100

This issue was solved with changeset r36950.
Zachary, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • ext/pathname/lib/pathname.rb: Documentation for Pathname.
  • ext/pathname/pathname.c: ditto. [Bug #6947]

Also available in: Atom PDF