This repository was archived by the owner on Jun 1, 2023. It is now read-only.
Fix Markdown listing of function parameters #171
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #170
It's my first time diving into SwiftDoc codebase. Excuse me if I say something wrong.
The code which list parameters is at
swift-doc/Supporting Types/Components/Documentation.swift:52
.Parameter#description
returns a string representation of the object, which includes the name and-
.I didn't look further into it, but obviously we were repeating the parameter name and adding an additional dash.
In the end, I replaced
parameter.description
withparameter.content
(thanks toDocumentation.swift:122
).It works now.