Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support -- ^ comment style #1297

Open
parsonsmatt opened this issue Jul 14, 2021 · 0 comments
Open

Support -- ^ comment style #1297

parsonsmatt opened this issue Jul 14, 2021 · 0 comments

Comments

@parsonsmatt
Copy link
Collaborator

Currently, you must use the -- | comment style for documenting fields and entities. This is not idiomatic Haskell, and folks often want to use -- ^ for documenting fields.

Related to #1296

Right now, you need to document like this:

-- | A table
SomeTable
    -- | Some Field
    someField Text

Ideally, we would be able to document like this:

-- | A table
SomeTable
    someField Text 
    -- ^ Some Field

Supporting same-line comments seems useful too.

SomeTable
    someField Text -- ^ This is a doc comment.

It seems less obvious that documenting entities like this makes sense. I've never see this on a Haskell datatype and I'm not sure it's even valid syntax.

SomeTable
    someField Text -- ^ Doc Comment
-- ^ I am a doc comment for SomeTable?? Weird.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant