@since annotations on exports
from Ben Gamari:
It should be possible to annotate re-exported declarations with
@since
annotations. For instance, imagine we have a moduleFoo
. In version0.2
of the package providingFoo
we might decide we want to re-exportBar.bat
fromFoo
. In order to communicate this change to the user we would want to write something like:module Foo ( bat -- ^ @since 0.2 ) where import Bar (bat)
Ideally
Foo
's documentation would then reproduce the documentation ofFoo
but with the@since
annotation saying something likeSince: 0.2 (exported from 'Bar')
.The syntax here is somewhat odd:
@since
comments in export lists must be expressed as-- ^
docstrings as the usual-- |
syntax in an export list is already used to express a docstring comment detached from any declaration.