fix: first line comments need to be in the {{/* */}} block, see gohugoio/hugo#7243

Apply suggestions from code review

Co-authored-by: Tim Bannister <[email protected]>

fix: apply review suggestions

Author: SayakMukhopadhyay

layouts/_default/search.html

@@ -1,7 +1,7 @@
-<!--
+{{/*
 Copied from Docsy with the addition of the search-input and the customSearch block.
-Revisit this once https://github.com/google/docsy/issues/2194 and https://github.com/google/docsy/pull/1512 are closed
--->
+Revisit this if / when either of https://github.com/google/docsy/issues/2194 and https://github.com/google/docsy/pull/1512 are closed
+*/}}
 {{ define "main" }}
 <!--From shortcodes/site-searchbar.html which is used in the home page-->
 <div class="col-sm-6 col-md-6 col-lg-6 mx-auto py-3">

layouts/partials/scripts.html

@@ -33,7 +33,7 @@
 {{ $jsSearch := resources.Get "js/search.js" | resources.ExecuteAsTemplate "js/search.js" .Site.Home }}
 {{ if .Site.Params.offlineSearch }}
 {{ $jsSearch = resources.Get "js/offline-search.js" }}
-<!-- Revisit this once https://github.com/google/docsy/issues/2194 and https://github.com/google/docsy/pull/1512 are closed -->
+{{/* Revisit this if / when either of https://github.com/google/docsy/issues/2194 and https://github.com/google/docsy/pull/1512 are closed */}}
 {{ else if .Site.Params.customSearch }}
 {{ $jsSearch = resources.Get "js/custom-search.js" }}
 {{ end }}

layouts/partials/search-input-custom.html

@@ -1,4 +1,4 @@
-<!-- Revisit this once https://github.com/google/docsy/issues/2194 and https://github.com/google/docsy/pull/1512 are closed -->
+{{/* Revisit this if / when either of https://github.com/google/docsy/issues/2194 and https://github.com/google/docsy/pull/1512 are closed */}}
 {{ $lang := .Site.Language.Lang }}
 {{ $searchFile := printf "content/%s/search.md" $lang }}
 

layouts/partials/search-input.html

@@ -1,7 +1,8 @@
-<!--
+{{/*
 Copied from Docsy with the addition of the customSearch block.
 This can be deleted once https://github.com/google/docsy/issues/2194 and https://github.com/google/docsy/pull/1512 are closed
--->
+and the site has been updated to incorporate the upstream change.
+*/}}
 {{ if .Site.Params.gcs_engine_id -}}
 <div class="td-search">
   <div class="td-search__icon"></div>