Bug #6947: Documentation for Pathname

• Status: Closed
• Assignee: zzak (zzak _)
• Target version: 2.0.0
• ruby -v: 2.0.0

[zzak (zzak _)]

I've added a documentation patch for Pathname.

[drbrain (Eric Hodel)]

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."

[zzak (zzak _)]

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.

[drbrain (Eric Hodel)]

"Pathname represents ..." is good

[zzak (zzak _)]

• File 0002-Documentation-for-Pathname.patch 0002-Documentation-for-Pathname.patch added

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

Thanks

[drbrain (Eric Hodel)]

This looks good, please commit it.

[drbrain (Eric Hodel)]

• Assignee changed from drbrain (Eric Hodel) to zzak (zzak _)

[zzak (zzak _)]

• 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] [ruby-core:47354]