From 5f1aec0838be71b881ddff6b8aa4db4a1cc83c2f Mon Sep 17 00:00:00 2001 From: Jason Zaugg Date: Thu, 7 Nov 2013 16:08:13 +0100 Subject: Update documentation --- CONTRIBUTING.md | 8 +++++++- README.md | 6 ------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9cd4bb5..00f617f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,13 @@ http://www.scala-lang.org/sites/default/files/contributor_agreement.pdf Before submitting a pull-request, please make sure you have followed the guidelines outlined in our [Pull Request Policy](https://github.com/scala/scala/wiki/Pull-Request-Policy). -### Generated Code examples +## Troubleshooting + - Logging of the transform can be enabled with `scalac -Dscala.async.debug=true`. + - Tracing of the ANF transform: `scalac -Dscala.async.trace=true` + - Debug the macro expansion by checking out the project and executing the application + [`scala.async.TreeInterrogation`](https://github.com/scala/async/blob/master/src/test/scala/scala/async/TreeInterrogation.scala#L59) + +## Generated Code examples ```scala val future = async { diff --git a/README.md b/README.md index 8283c11..6a1676b 100644 --- a/README.md +++ b/README.md @@ -138,12 +138,6 @@ difficult to understand. b) completes the result Promise of the async block, if at the terminal state. - an `apply(): Unit` method that starts the computation. -## Troubleshooting - - Logging of the transform can be enabled with `scalac -Dscala.async.debug=true`. - - Tracing of the ANF transform: `scalac -Dscala.async.trace=true` - - Debug the macro expansion by checking out the project and executing the application - [`scala.async.TreeInterrogation`](https://github.com/scala/async/blob/master/src/test/scala/scala/async/TreeInterrogation.scala#L59) - ## Limitations - See the [neg](https://github.com/scala/async/tree/master/src/test/scala/scala/async/neg) test cases for for constructs that are not allowed in a async block -- cgit v1.2.3