Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Commit ffa22e8

Browse files
authored
Fix markup for parameter descriptions in HTML output (#156)
* Remove extra </td> tag * Render parameter documentation content instead of description * Add changelog entry for #156
1 parent b9c405d commit ffa22e8

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

Changelog.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4343
- Fixed regression that caused nodes in relationships graph
4444
to not have links to their corresponding symbol documentation.
4545
#153 by @mattt.
46+
- Fixed markup for parameter descriptions in HTML output.
47+
#156 by @mattt.
4648

4749
## [1.0.0-beta.3] - 2020-05-19
4850

Sources/swift-doc/Supporting Types/Components/Documentation.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ struct Documentation: Component {
119119
type = nil
120120
}
121121

122-
return (entry.name, type, entry.description)
122+
return (entry.name, type, entry.content)
123123
}
124124

125125
fragments.append(#"""
@@ -145,7 +145,7 @@ struct Documentation: Component {
145145
return #"""
146146
<tr>
147147
<th>\#(softbreak(entry.name))</th>
148-
\#(typeCell)</td>
148+
\#(typeCell)
149149
<td>\#(commonmark: entry.description)</td>
150150
</tr>
151151
"""# as HypertextLiteral.HTML

0 commit comments

Comments
 (0)