Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[api-documenter] Fix return block rendering for page markdown #4638

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[api-documenter] Fix return block rendering for page markdown #4638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5fa3dc6
Fix return block rendering for page markdown
colincasey Apr 12, 2024
eed627b
Update snapshot
colincasey Apr 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions apps/api-documenter/src/documenters/MarkdownDocumenter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -895,6 +895,7 @@ export class MarkdownDocumenter {
if (parametersTable.rows.length > 0) {
output.appendNode(new DocHeading({ configuration, title: 'Parameters' }));
output.appendNode(parametersTable);
output.appendNode(new DocParagraph({ configuration }));
}

if (ApiReturnTypeMixin.isBaseClassOf(apiParameterListMixin)) {
Expand Down
10 changes: 10 additions & 0 deletions build-tests/api-documenter-test/src/test/__snapshots__/snapshot.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1580,6 +1580,7 @@ number

</td></tr>
</tbody></table>

",
"/api-documenter-test.docbaseclass.md": "<!-- Do not edit this file. It is automatically generated by API Documenter. -->

Expand Down Expand Up @@ -1730,6 +1731,7 @@ the second string

</td></tr>
</tbody></table>

**Returns:**

string
Expand Down Expand Up @@ -1790,6 +1792,7 @@ the number

</td></tr>
</tbody></table>

**Returns:**

number
Expand Down Expand Up @@ -1844,6 +1847,7 @@ some generic parameter.

</td></tr>
</tbody></table>

**Returns:**

void
Expand Down Expand Up @@ -2330,6 +2334,7 @@ _(Optional)_ the number

</td></tr>
</tbody></table>

**Returns:**

void
Expand Down Expand Up @@ -2440,6 +2445,7 @@ the second number to add

</td></tr>
</tbody></table>

**Returns:**

number
Expand Down Expand Up @@ -2811,6 +2817,7 @@ a system type that should NOT get hyperlinked

</td></tr>
</tbody></table>

**Returns:**

[IDocInterface1](./api-documenter-test.idocinterface1.md)
Expand Down Expand Up @@ -3491,6 +3498,7 @@ T

</td></tr>
</tbody></table>

**Returns:**

T
Expand Down Expand Up @@ -4453,6 +4461,7 @@ number

</td></tr>
</tbody></table>

**Returns:**

number
Expand Down Expand Up @@ -4585,6 +4594,7 @@ handler

</td></tr>
</tbody></table>

**Returns:**

void
Expand Down
10 changes: 10 additions & 0 deletions ...hanges/@microsoft/api-documenter/api_documenter_markdown_return_fix_2024-04-12-21-56.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@microsoft/api-documenter",
"comment": "Fix return block rendering for page markdown",
"type": "patch"
}
],
"packageName": "@microsoft/api-documenter"
}