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

Function parameter is not rendered correctly in CommonMark #170

Closed
domcorvasce opened this issue Aug 22, 2020 · 0 comments · Fixed by #171
Closed

Function parameter is not rendered correctly in CommonMark #170

domcorvasce opened this issue Aug 22, 2020 · 0 comments · Fixed by #171

Comments

@domcorvasce
Copy link
Contributor

domcorvasce commented Aug 22, 2020

Hi.
First, let me say that I really appreciate SwiftDoc and the work you're putting into it. It's awesome.

I noticed a minor issue that arises when listing function parameters in Markdown.
This issue does not concern the HTML documentation.

How to Reproduce

Code:

/// Does something with two-dimensional arrays
///
/// - Parameter arr: Two-dimensional array of elements
init(_ arr: [[ElementType]]) {
  // ...
}

Markdown:

- arr:​ - arr:​ Two-dimensional array of elements

Schermata 2020-08-22 alle 9 33 35 AM

Fix

#171

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant