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

Format comments as haddock #131

Merged
merged 2 commits into from May 3, 2020
Merged

Format comments as haddock #131

merged 2 commits into from May 3, 2020

Conversation

bsima
Copy link
Contributor

@bsima bsima commented Apr 17, 2020

I was browsing the comments and wanted to read them as docs in haddock.

@ddssff
Copy link
Collaborator

ddssff commented May 1, 2020

Thank you for this! It looks like haddock for ghc < 8.6 do not like the documentation of individual arguments, e.g. -- | minEntryId. Could you push a patch that removes these two lines?

@stepcut
Copy link
Member

stepcut commented May 1, 2020

Pretty sure for arguments you use -- ^ after the argument.

ilterLogFiles :: Maybe EntryId  -- ^ minEntryId
              -> Maybe EntryId  -- ^ maxEntryId
              -> [(EntryId, FilePath)] -> [(EntryId, FilePath)]

@bsima
Copy link
Contributor Author

bsima commented May 1, 2020

@ddssff Done!

@ddssff ddssff merged commit 5f5d078 into acid-state:master May 3, 2020
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

Successfully merging this pull request may close these issues.

None yet

3 participants