From 6ef5937a5c87479075722acf26bf18184ae90cbb Mon Sep 17 00:00:00 2001
From: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
Date: Sat, 16 Jun 2018 15:29:11 +0200
Subject: [PATCH] docs/website-doc.sh: minor improvements in comments of
 versions.yml

Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
---
 docs/website-doc.sh | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/docs/website-doc.sh b/docs/website-doc.sh
index 5dbe456..c8d240b 100755
--- a/docs/website-doc.sh
+++ b/docs/website-doc.sh
@@ -55,9 +55,13 @@ function api () {
   # This let know the website about the available APIs documentations.
   echo "Building Jekyll data: $VERSIONS_YML"
   # Erase previous content.
-  echo "$HEADER" > "$VERSIONS_YML"
-  echo "# However, it's correct to /remove/ old API docs here."
-  echo "# While at it, don't forget to adjust the _doc/versions directory."
+  echo > "$VERSIONS_YML" <<EOF
+$HEADER
+# Used to publish the APIs.
+#
+# However, it's correct to _remove_ old API docs here. In this case, don't
+# forget to adjust the _doc/versions directory too.
+EOF
   for version in $(ls "$DESTBASE" -1 | sort -nr)
   do
     echo "- $version"