git.iko.soy/streamly
on master help sign in
Add haddock instructions for experimental APIs
a4c2ae4Harendra Kumar
README.md+7
compare with master
unifiedsplit
@@ -585,6 +585,13 @@ For more information, see:
585 * [Streaming benchmarks](https://github.com/composewell/streaming-benchmarks)
585 * [Streaming benchmarks](https://github.com/composewell/streaming-benchmarks)
586 * [Concurrency benchmarks](https://github.com/composewell/concurrency-benchmarks)
586 * [Concurrency benchmarks](https://github.com/composewell/concurrency-benchmarks)
587
587
588+For additional unreleased/experimental APIs, build the haddock docs using:
589+
590+```
591+$ cabal haddock --haddock-option="--show-all"
592+$ stack haddock --haddock-arguments "--show-all" --no-haddock-deps
593+```
594+
588## Support
595## Support
589
596
590Please feel free to ask questions on the
597Please feel free to ask questions on the
streamly.cabal+6
@@ -74,6 +74,12 @@ description:
74 cases.
74 cases.
75 * <https://github.com/composewell/streaming-benchmarks Streaming Benchmarks>
75 * <https://github.com/composewell/streaming-benchmarks Streaming Benchmarks>
76 * <https://github.com/composewell/concurrency-benchmarks Concurrency Benchmarks>
76 * <https://github.com/composewell/concurrency-benchmarks Concurrency Benchmarks>
77+ .
78+ For additional unreleased/experimental APIs, build the haddock docs using:
79+ .
80+ > $ cabal haddock --haddock-option="--show-all"
81+ > $ stack haddock --haddock-arguments "--show-all" --no-haddock-deps
82+
77
83
78homepage: https://github.com/composewell/streamly
84homepage: https://github.com/composewell/streamly
79bug-reports: https://github.com/composewell/streamly/issues
85bug-reports: https://github.com/composewell/streamly/issues