From 247dab8fc3886e4fa757bdc06f3f004f0cbb88f6 Mon Sep 17 00:00:00 2001
From: Darcy Wong <darcy_wong@sil.org>
Date: Fri, 10 Mar 2023 09:40:28 +0700
Subject: [PATCH] Apply suggestions from code review

Co-authored-by: Marc Durdin <marc@durdin.net>
---
 resources/build/build-help.inc.sh | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/resources/build/build-help.inc.sh b/resources/build/build-help.inc.sh
index f0c62e036f..8d07028cb5 100644
--- a/resources/build/build-help.inc.sh
+++ b/resources/build/build-help.inc.sh
@@ -59,7 +59,26 @@ function _build_help_build() {
   cp $KEYMAN_ROOT/$PLATFORM/help/${PLATFORM}_images/* "$DESTHTM/${PLATFORM}_images/"
 }
 
-function _help() {
+#
+# Builds .html files from .md source
+#
+# ### Usage
+# 
+# ```bash
+#   build_help_html platform output_path
+# ```
+# 
+# ### Parameters
+# 
+# * `platform`     the platform to build, matching the platform folder name
+# * `output_path`  path to emit files to, relative to `$KEYMAN_ROOT/$platform`
+# 
+# ### Description
+# 
+# Expects to find .md source under $KEYMAN_ROOT/$platform/help/, and
+# will write the output .html to $KEYMAN_ROOT/$platform/$output_path.
+#
+function build_help_html() {
   pushd $(pwd)
   _build_help_clean $1
   _build_help_build $1