elm-lang / elm-package

Command line tool to share Elm libraries

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Spurious `DOCUMENTATION ERROR` when @docs on first line

rtfeldman opened this issue · comments

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|>-}

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.

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.)