review feedback

microsoft · Sep 9, 2024 · 3bbd7de · 3bbd7de
1 parent 718bd9b
commit 3bbd7de
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/packages/playwright/types/test.d.ts b/packages/playwright/types/test.d.ts
@@ -2682,7 +2682,8 @@ export interface TestType<TestArgs extends KeyValue, WorkerArgs extends KeyValue
  * - Running tests serially, retrying from the start.
  *
  * **NOTE** Running serially is not recommended. It is usually better to make your tests isolated, so they can be
- * run independently.
+ * run
+ * independently.
  *
  * ```js
  * // Annotate tests as inter-dependent.

diff --git a/utils/doclint/documentation.js b/utils/doclint/documentation.js
@@ -794,6 +794,7 @@ function patchLinksInText(classOrMember, text, classesMap, membersMap, linkRende
  * @param {MarkdownNode[] | undefined} spec
  */
 function generateSourceCodeComment(spec) {
+ const renderOptions = { maxColumns: 120 - 5, omitLastCR: true, flattenText: true };
  const comments = (spec || []).filter(n => !n.type.startsWith('h') && (n.type !== 'li' || n.liType !== 'default')).map(c => md.clone(c));
  md.visitAll(comments, node => {
  if (node.type === 'li' && node.liType === 'bullet')
@@ -803,11 +804,12 @@ function generateSourceCodeComment(spec) {
  if (node.type === 'note') {
  // @ts-ignore
  node.type = 'text';
- node.text = '**NOTE** ' + node.text;
+ const text = '**NOTE** ' + (node.children || []).map(child => md.render([child], renderOptions)).join('\n');
+ node.text = md.wrapText(text.replace(/\n/g, '↵'), renderOptions, '');
  }
  });
  // 5 is a typical member doc offset.
- return md.render(comments, { maxColumns: 120 - 5, omitLastCR: true, flattenText: true });
+ return md.render(comments, renderOptions);
 }
 
 /**

diff --git a/utils/markdown.js b/utils/markdown.js
@@ -50,7 +50,6 @@
 
 /** @typedef {MarkdownBaseNode & {
  * type: 'note',
- * text: string,
  * noteType: string,
  * }} MarkdownNoteNode */
 
@@ -208,7 +207,7 @@ function buildTree(lines) {
  tokens.push(line.substring(indent.length));
  line = lines[++i];
  }
- node.text = tokens.join('↵');
+ node.children = buildTree(tokens);
  appendNode(indent, node);
  continue;
  }
@@ -341,7 +340,8 @@ function innerRenderMdNode(indent, node, lastNode, result, options) {
  if (node.type === 'note') {
  newLine();
  result.push(`${indent}:::${node.noteType}`);
- result.push(wrapText(node.text, options, indent));
+ for (const child of node.children || [])
+ innerRenderMdNode(indent, child, lastNode, result, options);
  result.push(`${indent}:::`);
  newLine();
  return;