git.iko.soy/streamly
on master help sign in
use haddock "--show-all" for dev docs
commit09c955ea1e79efb1fa6923353e6ceb6d57b3eb31 authorHarendra Kumar <harendra.kumar@gmail.com> dateWed 11 Jul 2018, 20:22 (8 years ago) parent352d3a2
2 files changed+5−18
compare with master
unifiedsplit
CONTRIBUTING.md+4−3 streamly.cabal+1−15
CONTRIBUTING.md+4−3
@@ -11,9 +11,10 @@ for any problem that you may encounter.
1111
1212## Developer documentation
1313
14−Build haddock with the `dev` flag to see the whole documentation and module
15−structure. For example,
16−`stack haddock --flag "streamly:dev" --no-haddock-deps`.
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.
16+For example,
17+`stack haddock --haddock-arguments "--show-all" --no-haddock-deps`.
1718
1819## Pull Requests (PR)
1920
streamly.cabal+1−15
@@ -122,21 +122,7 @@ flag examples-sdl
122122
123123library
124124 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:
139− Streamly.SVar
125+ other-modules: Streamly.SVar
140126 , Streamly.Streams.StreamK
141127 , Streamly.Streams.StreamD
142128 , Streamly.Streams.Serial