finos / finos/morphir-elm

Include module level documentation in the IR

Open
#86 0 comments 0 reactions 1 assignee Claimed by @AttilaMihaly View on GitHub
enhancement
Dominant language
Elm
Stars
51
Forks
69
Avg merge
25m
Merged PRs (30d)
1

Description

Currently documentation is available at the type level, but if you provide module level docs those are not reflected in the IR.

In the example below, the Bar module's docs will not be present in the IR.

```elm
module Sample.Bar exposing (..)

{-|The Bar module
# Section 1
This is section 1

# Section 2
This is section 2

-}

{-|The Bar type. -}
type Bar
= Snickers
| Twix
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.