From cbc5c6f79254f9d0c78c1d593b74d97a199a3e79 Mon Sep 17 00:00:00 2001 From: gandrianakis Date: Mon, 6 Jun 2016 12:40:02 +0300 Subject: [PATCH] Slight improvement of wording in the section that explains the benefits of contributing code examples for library functions --- ReadMe.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ReadMe.md b/ReadMe.md index b15bf23a922..8a36cdf97df 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -117,7 +117,7 @@ and find classes or functions which are not documented very well and submit a pa In particular it'd be great if all functions included a nice example of how to use it such as for the hashMapOf() function. This is implemented using the @sample -macro to include code from a test function. This serves as a double win; the API gets better documented with nice examples to help new users and the code gets more test coverage. +macro to include code from a test function. The benefits of this approach are twofold; First, the API's documentation is improved via beneficial examples that help new users and second, the code coverage is increased. Also the [JavaScript translation](https://github.com/JetBrains/kotlin/blob/master/js/ReadMe.md) could really use your help. See the [JavaScript contribution section](https://github.com/JetBrains/kotlin/blob/master/js/ReadMe.md) for more details.