summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--ChangeLog5
-rw-r--r--ext/pathname/pathname.c19
2 files changed, 24 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index 7862f89d7d..f8b893fe29 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Mon Jan 9 20:26:33 2012 Tanaka Akira <akr@fsij.org>
+
+ * ext/pathname/pathname.c (path_entries): add document suggested by
+ the thread [ruby-core:41959] [Bug #5859].
+
Mon Jan 9 20:14:13 2012 Tanaka Akira <akr@fsij.org>
* ext/socket/lib/socket.rb (family_addrinfo): don't require protocol
diff --git a/ext/pathname/pathname.c b/ext/pathname/pathname.c
index e1632c524b..bde58a3e21 100644
--- a/ext/pathname/pathname.c
+++ b/ext/pathname/pathname.c
@@ -861,8 +861,27 @@ path_s_getwd(VALUE klass)
* Return the entries (files and subdirectories) in the directory, each as a
* Pathname object.
*
+ * The result contains just a filename which has no directory.
+ *
* The result may contain the current directory #<Pathname:.> and the parent
* directory #<Pathname:..>.
+ *
+ * If you don't want #<Pathname:.> and #<Pathname:..> and
+ * want directory, consider Pathname#children.
+ *
+ * pp Pathname.new('/usr/local').entries
+ * #=> [#<Pathname:share>,
+ * # #<Pathname:lib>,
+ * # #<Pathname:..>,
+ * # #<Pathname:include>,
+ * # #<Pathname:etc>,
+ * # #<Pathname:bin>,
+ * # #<Pathname:man>,
+ * # #<Pathname:games>,
+ * # #<Pathname:.>,
+ * # #<Pathname:sbin>,
+ * # #<Pathname:src>]
+ *
*/
static VALUE
path_entries(VALUE self)