git.iko.soy/streamly
on master help sign in
use haddock "--show-all" for dev docs
09c955eHarendra Kumar
CONTRIBUTING.md+4−3
compare with master
unifiedsplit
@@ -11,9 +11,10 @@ for any problem that you may encounter.
11
11
12## Developer documentation
12## Developer documentation
13
13
14−Build haddock with the `dev` flag to see the whole documentation and module
14+Build haddock with the `--show-all` option to see the documentation for all
15+modules including the ones not exposed to users of the library.
15−structure. For example,
16+For example,
16−`stack haddock --flag "streamly:dev" --no-haddock-deps`.
17+`stack haddock --haddock-arguments "--show-all" --no-haddock-deps`.
17
18
18## Pull Requests (PR)
19## Pull Requests (PR)
19
20
streamly.cabal+1−15
@@ -122,21 +122,7 @@ flag examples-sdl
122
122
123library
123library
124 hs-source-dirs: src
124 hs-source-dirs: src
125− if flag(dev)
126− exposed-modules:
127− Streamly.SVar
128− , Streamly.Streams.StreamK
129− , Streamly.Streams.StreamD
130− , Streamly.Streams.Serial
131− , Streamly.Streams.SVar
132− , Streamly.Streams.Async
133− , Streamly.Streams.Parallel
134− , Streamly.Streams.Ahead
135− , Streamly.Streams.Zip
136− , Streamly.Streams.Prelude
137− else
138− other-modules:
125+ other-modules: Streamly.SVar
139− Streamly.SVar
140 , Streamly.Streams.StreamK
126 , Streamly.Streams.StreamK
141 , Streamly.Streams.StreamD
127 , Streamly.Streams.StreamD
142 , Streamly.Streams.Serial
128 , Streamly.Streams.Serial