04/06: gnu: home: Add doc comment about the module.

[guix-commits]

wigust pushed a commit to branch wip-guix-home
in repository guix.

commit bb9e4c0848ab07afcb3337a24547693d6c7fdcec
Author: Andrew Tropin <andrew@trop.in>
AuthorDate: Mon Aug 30 12:07:48 2021 +0300

    gnu: home: Add doc comment about the module.
    
    Signed-off-by: Oleg Pykhalov <go.wigust@gmail.com>
---
 gnu/home.scm | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/gnu/home.scm b/gnu/home.scm
index a53d271..f4c9359 100644
--- a/gnu/home.scm
+++ b/gnu/home.scm
@@ -38,6 +38,14 @@
 
             home-environment-with-provenance))
 
+;;; Comment:
+;;;
+;;; This module provides a <home-environment> record for managing
+;;; per-user packages and configuration files in the similar way as
+;;; <operating-system> do for system packages and configuration files.
+;;;
+;;; Code:
+
 (define-record-type* <home-environment> home-environment
   make-home-environment
   home-environment?