Skip to content

Commit 9b92368

Browse files
[api-documenter] Ensure empty line after tables (#5256)
* Ensure empty line after tables (fix #4878) * update api-extractor-scenarios snapshots * Update common/changes/@microsoft/api-documenter/fix-api-documenter-missing-new-lines-after-tables_2025-06-17-22-12.json --------- Co-authored-by: Pete Gonzalez <[email protected]>
1 parent 7364f99 commit 9b92368

20 files changed

+67
-1
lines changed

apps/api-documenter/src/markdown/CustomMarkdownEmitter.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ export class CustomMarkdownEmitter extends MarkdownEmitter {
136136
}
137137
writer.write('</tbody>');
138138
writer.write('</table>');
139-
writer.writeLine();
139+
writer.ensureSkippedLine();
140140

141141
break;
142142
}

apps/api-documenter/src/markdown/test/CustomMarkdownEmitter.test.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,13 @@ test('render Markdown from TSDoc', () => {
171171
)
172172
]);
173173

174+
output.appendNodes([
175+
new DocHeading({ configuration, title: 'After a table' }),
176+
new DocParagraph({ configuration }, [
177+
new DocPlainText({ configuration, text: 'just checking lines after a table' }),
178+
])
179+
]);
180+
174181
const stringBuilder: StringBuilder = new StringBuilder();
175182
const apiModel: ApiModel = new ApiModel();
176183
const markdownEmitter: CustomMarkdownEmitter = new CustomMarkdownEmitter(apiModel);

apps/api-documenter/src/markdown/test/__snapshots__/CustomMarkdownEmitter.test.ts.snap

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,5 +75,10 @@ Cell 2
7575
7676
</td></tr>
7777
</tbody></table>
78+
79+
## After a table
80+
81+
just checking lines after a table
82+
7883
"
7984
`;

build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,3 +166,4 @@ Some overload. Overrides `Class3.someOverload`<!-- -->.
166166
167167
</td></tr>
168168
</tbody></table>
169+

build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.someoverload.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ boolean \| string
4545

4646
</td></tr>
4747
</tbody></table>
48+
4849
**Returns:**
4950

5051
void

build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,3 +161,4 @@ Some overload.
161161
162162
</td></tr>
163163
</tbody></table>
164+

build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.somemethod.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ boolean
4545

4646
</td></tr>
4747
</tbody></table>
48+
4849
**Returns:**
4950

5051
void

build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsinterfaceliketypealias.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,4 @@ Some prop.
8181
8282
</td></tr>
8383
</tbody></table>
84+

build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,3 +96,4 @@ A third prop.
9696
9797
</td></tr>
9898
</tbody></table>
99+

build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,3 +73,4 @@ Some prop.
7373

7474
</td></tr>
7575
</tbody></table>
76+

0 commit comments

Comments
 (0)