cabal-extras icon indicating copy to clipboard operation
cabal-extras copied to clipboard

cabal-docspec: gets confused by -- $setup in export list

Open tonyday567 opened this issue 4 years ago • 2 comments
trafficstars

I usually place -- $setup in the export list for the haddocks, which I think is valid haddock/doctest practice. It looks like cabal-docspec picks this one up and then ignores the main one.

I don't mind if this is a feature rather than a bug, but it's a variance when moving from doctest to cabal-docspec.

tonyday567 avatar Sep 06 '21 20:09 tonyday567

This is a bug. You are the first who actually shows users what is in $setup :)

I'll see how easy/hard is this to fix...

phadej avatar Sep 06 '21 23:09 phadej

I put $setup in export lists, to display it in haddock docs, like below, and it seems to be working well with cabal-docspec:

module Streamly.Data.Fold
    (
    -- * Imports for Examples
    -- $setup

    -- * Running A Fold

harendra-kumar avatar Mar 11 '23 08:03 harendra-kumar