[DOC] Describe Dir.home

1 files changed, 3 insertions, 0 deletions

diff --git a/dir.c b/dir.c
index 21b1acada3..63235eea9a 100644
--- a/dir.c
+++ b/dir.c
@@ -3478,6 +3478,9 @@ file_s_fnmatch(int argc, VALUE *argv, VALUE obj)
  * call-seq:
  *   Dir.home(user_name = nil) -> dirpath
  *
+ * Retruns the home directory path of the user specified with +user_name+
+ * if it is not +nil+, or the current login user:
+ *
  *   Dir.home         # => "/home/me"
  *   Dir.home('root') # => "/root"
  *