This repository was archived by the owner on Jun 1, 2023. It is now read-only.
Fix Markdown listing of function parameters#171
Merged
Conversation
Contributor
|
Great work, @domcorvasce! I fixed this for HTML with #156, but neglected to make the corresponding fix for CommonMark. Thanks for your help with this — I really appreciate it! |
mattt
approved these changes
Aug 22, 2020
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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#descriptionreturns 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.descriptionwithparameter.content(thanks toDocumentation.swift:122).It works now.