Skip to content
This repository has been archived by the owner on Aug 23, 2018. It is now read-only.

Spurious DOCUMENTATION ERROR when @docs on first line #272

Open
rtfeldman opened this issue May 22, 2017 · 2 comments
Open

Spurious DOCUMENTATION ERROR when @docs on first line #272

rtfeldman opened this issue May 22, 2017 · 2 comments
Labels

Comments

@rtfeldman
Copy link

I should SSCCE this, but in the meantime: reporting it so I don't lose track of it.

Basic problem is that when elm-package checks for @docs it ignores them if they're on the first line.

==================================== ERRORS ====================================

-- DOCUMENTATION ERROR ------------------------------- ./src/Test/Html/Query.elm

The following exports do not appear in your module documentation: Multiple
Single fromHtml

17|>{-| @docs Single, Multiple, fromHtml
18|>
19|>
20|>## Querying
21|>
22|>@docs find, findAll, children, first, index
23|>
24|>
25|>## Expecting
26|>
27|>@docs count, has, hasNot, each
28|>
29|>-}
@process-bot
Copy link

Thanks for the issue! Make sure it satisfies this checklist. My human colleagues will appreciate it!

Here is what to expect next, and if anyone wants to comment, keep these things in mind.

@avh4
Copy link

avh4 commented May 23, 2017

To restate the current behavior: the parser currently requires that @docs occur in the first column.

(FYI, the latest elm-format will reformat your example code to move the first @docs to its own line.)

@evancz evancz added bug problem and removed bug labels Jul 10, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

4 participants