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

Broken haddocks for exprAndHeaderFromText #1707

Closed
sjakobi opened this issue Mar 15, 2020 · 0 comments · Fixed by #1708
Closed

Broken haddocks for exprAndHeaderFromText #1707

sjakobi opened this issue Mar 15, 2020 · 0 comments · Fixed by #1708

Comments

@sjakobi
Copy link
Collaborator

sjakobi commented Mar 15, 2020

{-| Like `exprFromText` but also returns the leading comments and whitespace
(i.e. header) up to the last newline before the code begins
In other words, if you have a Dhall file of the form:
> -- Comment 1
> {- Comment -} 2
Then this will preserve @Comment 1@, but not @Comment 2@
This is used by @dhall-format@ to preserve leading comments and whitespace
-}
exprAndHeaderFromText

The inline comment {- Comment -} is confusingly missing in the rendered haddocks:

image

sjakobi added a commit that referenced this issue Mar 15, 2020
sjakobi added a commit that referenced this issue Mar 15, 2020
@mergify mergify bot closed this as completed in #1708 Mar 15, 2020
mergify bot pushed a commit that referenced this issue Mar 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant