Update script comments

errose28 · Feb 12, 2024 · 6da1295 · 6da1295
1 parent 36cadf7
commit 6da1295
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/.github/scripts/names.sh b/.github/scripts/names.sh
@@ -17,7 +17,8 @@
 # under the License.
 
 
-# Checks all page files and their parent directories to ensure that they use docusaurus number prefixes and are named all lower case with kebab-case.
+# Checks all page files and their parent directories to ensure that they use docusaurus number prefixes and are named
+# all lower case with kebab-case.
 
 root="$(git rev-parse --show-toplevel)"
 rc=0
@@ -65,4 +66,3 @@ for file in $(find "$root"/src/pages/*); do
 done
 
 exit "$rc"
-
diff --git a/.github/scripts/sidebar.sh b/.github/scripts/sidebar.sh
@@ -18,6 +18,7 @@
 
 
 # Validates docusaurus _category_.yml files used to configure the docs sidebar.
+# Each docs subdirectory should have a _category_.yml file, and it must follow the defined schema.
 
 rc=0
 
@@ -43,4 +44,3 @@ for child in $(find "$root"/docs/*); do
 done
 
 exit "$rc"
-
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,6 +18,7 @@ @@
     # Validates docusaurus _category_.yml files used to configure the docs sidebar.
+    # Each docs subdirectory should have a _category_.yml file, and it must follow the defined schema.
     rc=0
@@ Expand All / @@ -43,4 +44,3 @@ for child in $(find "$root"/docs/*); do @@
     done
     exit "$rc"