Add haddock instructions for experimental APIs
commita4c2ae4311fdcb752c4616cd249a11a2d8aeeb98
authorHarendra Kumar <harendra.kumar@gmail.com>
dateFri 15 Nov 2019, 02:21 (7 years ago)
parent79a0c1e
README.md+7
@@ -585,6 +585,13 @@ For more information, see:
585585 * [Streaming benchmarks](https://github.com/composewell/streaming-benchmarks)
586586 * [Concurrency benchmarks](https://github.com/composewell/concurrency-benchmarks)
587587
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+
588595## Support
589596
590597Please feel free to ask questions on the
streamly.cabal+6
@@ -74,6 +74,12 @@ description:
7474 cases.
7575 * <https://github.com/composewell/streaming-benchmarks Streaming Benchmarks>
7676 * <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+
7783
7884homepage: https://github.com/composewell/streamly
7985bug-reports: https://github.com/composewell/streamly/issues