Add haddock instructions for experimental APIs

composewell · Nov 14, 2019 · a4c2ae4 · a4c2ae4
1 parent 79a0c1e
commit a4c2ae4
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -585,6 +585,13 @@ For more information, see:
   * [Streaming benchmarks](https://github.com/composewell/streaming-benchmarks)
   * [Concurrency benchmarks](https://github.com/composewell/concurrency-benchmarks)
 
+For additional unreleased/experimental APIs, build the haddock docs using:
+
+```
+$ cabal haddock --haddock-option="--show-all"
+$ stack haddock --haddock-arguments "--show-all" --no-haddock-deps
+```
+
 ## Support
 
 Please feel free to ask questions on the

diff --git a/streamly.cabal b/streamly.cabal
@@ -74,6 +74,12 @@ description:
     cases.
   * <https://github.com/composewell/streaming-benchmarks Streaming Benchmarks>
   * <https://github.com/composewell/concurrency-benchmarks Concurrency Benchmarks>
+  .
+  For additional unreleased/experimental APIs, build the haddock docs using:
+  .
+  > $ cabal haddock --haddock-option="--show-all"
+  > $ stack haddock --haddock-arguments "--show-all" --no-haddock-deps
+
 
 homepage:            https://github.com/composewell/streamly
 bug-reports:         https://github.com/composewell/streamly/issues