Clarify helper function

WordPress · Dec 20, 2024 · e5e4a65 · e5e4a65
1 parent 869d26b
commit e5e4a65
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/bin/api-docs/gen-components-docs/markdown/index.mjs b/bin/api-docs/gen-components-docs/markdown/index.mjs
@@ -8,8 +8,17 @@ import json2md from 'json2md';
  */
 import { generateMarkdownPropsJson } from './props.mjs';
 
+/**
+ * If the string is contentful, ensure that it ends with a single newline.
+ * Otherwise normalize to `undefined`.
+ *
+ * @param {string} [str]
+ */
 function normalizeTrailingNewline( str ) {
-	return str?.length ? str.replace( /\n*$/, '\n' ) : undefined;
+	if ( ! str?.trim() ) {
+		return undefined;
+	}
+	return str.replace( /\n*$/, '\n' );
 }
 
 export function generateMarkdownDocs( { typeDocs, subcomponentTypeDocs } ) {