From 1b216173c7d11cf682492aefc149f02627068174 Mon Sep 17 00:00:00 2001 From: Julie LeBrun <38360781+TumbaoJu@users.noreply.github.com> Date: Tue, 30 Jul 2024 03:19:39 -0400 Subject: [PATCH] Update DESCRIPTION.md (#622) Proposition from the Functional Working Group Co-authored-by: Pedro M. Baeza Co-authored-by: Jairo Llopis <973709+yajo@users.noreply.github.com> --- template/module/readme/DESCRIPTION.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/template/module/readme/DESCRIPTION.md b/template/module/readme/DESCRIPTION.md index fc84a0ab1..2371a1464 100644 --- a/template/module/readme/DESCRIPTION.md +++ b/template/module/readme/DESCRIPTION.md @@ -1,5 +1,7 @@ -[ This file must be max 2-3 paragraphs, and is required. ] +[ This file must be max 2-3 paragraphs, and is required. -This module extends the functionality of ... to support ... -and to allow you to ... +The goal of this document is to explain quickly the features of this module: “what” this module does and “what” it is for. ] +Example: + +This module extends the functionality of ... to support ... and to allow users to ...