Skip to content

Support single pipe comment style #1296

@parsonsmatt

Description

@parsonsmatt

In persistent's QuasiQuoter, you can add documentation using a -- | style doc-comment. Like in purescript, the | must be present on every comment.

-- | This is a table.
-- | This is another line of the doc comment.
SomeTable
    -- | This is a field.
    -- | This is another line of the field comment.
    someField Text

However, this requirement is odd to Haskellers, so we should support having only a single pipe.

-- | This is a table.
-- This is another line of the doc comment.
SomeTable
    -- | This is a field.
    -- This is another line of the field comment
    someField Text

This issue is done when the two code blocks create equal commentary on the produced EntityDefs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions