Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.
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

Description

@domcorvasce

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions