Improve method documentation

yast · Sep 30, 2021 · 219e9fd · 219e9fd
1 parent 68530a2
commit 219e9fd
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/lib/y2users/user.rb b/src/lib/y2users/user.rb
@@ -150,6 +150,9 @@ def initialize(name)
 
     # Default home for the user
     #
+    # Generates a new {Home} object with the default user home path. The attributes of the current
+    # home object associated to the user are not copied.
+    #
     # @return [Home]
     def default_home
       Home.new("/home/#{name}")