Skip to content

Commit 6d8a198

Browse files
committed
documentation cosmetics
1 parent 1dbf092 commit 6d8a198

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

NEWS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ Other changes
2121
* Cache directory is now `~/.kscript`
2222
* More heuristics to guess `KOTLIN_HOME`
2323
* Cache cleanup `--clear-cache` now applies to jars, scripts, urls, and cached dependency lookups
24-
* Fixed compatibility with [Kotlin v1.1](https://kotlinlang.org/docs/reference/whatsnew11.html)
2524

2625

2726
## v1.2
2827

29-
* Fixed compatibility with kotlin v1.1 (fixes #15)
30-
* Added `-i` to dump interactive console command incl deps (fixes #10)
31-
* Compile jars should go to TEMP (fixes #13)
28+
* Fixed compatibility with [Kotlin v1.1](https://kotlinlang.org/docs/reference/whatsnew11.html)
29+
(fixes [#15](https://github.com/holgerbrandl/kscript/issues/15))
30+
* Added `-i` to dump interactive console command incl deps (fixes [#10](https://github.com/holgerbrandl/kscript/issues/10))
31+
* Compile jars should go to TEMP (fixes [#13](https://github.com/holgerbrandl/kscript/issues/13))
3232
* started test-suite
3333

3434
## v1.1

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ EOF
129129
kscript <(echo 'println("k-onliner")') arg1 arg2 arg3
130130
```
131131

132-
Inlined _kscripts_ are also cached based on `md5` checksum, so running the same snippet again will use a cached jar (sitting in `$TMPDIR`).
132+
Inlined _kscripts_ are also cached based on `md5` checksum, so running the same snippet again will use a cached jar (sitting in `~/.kscript`).
133133

134134

135135
Support API
@@ -144,7 +144,7 @@ When using the direct script arguments (like in the example below) the methods i
144144
cat some_file | kscript 'stdin.filter { "^de0[-0]*".toRegex().matches(it) }.map { it + "foo:" }.print()'
145145
```
146146

147-
The only element that comes from our support library is the `Sequence<String>` called `stdin` to process standard input. The rest of the example is stdlib Kotlin.
147+
The elements that come from our support library in the example are the [`stdin`](https://github.com/holgerbrandl/kscript-support-api/blob/master/src/main/kotlin/kscript/StreamUtil.kt#L11) object of type `Sequence<String>` to iterate over the standard input, and the extension method [`print`](https://github.com/holgerbrandl/kscript-support-api/blob/master/src/main/kotlin/kscript/StreamUtil.kt#L34) to print the lines to stdout. The rest is stdlib Kotlin.
148148

149149
For more examples using the support library see our [Support API Manual](docs/support_api.md).
150150

@@ -197,7 +197,7 @@ How to contribute?
197197

198198
We always welcome pull requests. :-)
199199

200-
You could also show your support upvoting `kscript` here on github, or by voting for issues in Intellij IDEA which impact `kscript`ing. Here are our top 3 tickets/annoyances that we would love to see fixed:
200+
You could also show your support by upvoting `kscript` here on github, or by voting for issues in Intellij IDEA which impact `kscript`ing. Here are our top 3 tickets/annoyances that we would love to see fixed:
201201

202202
1. [KT-13347](https://youtrack.jetbrains.com/issue/KT-13347) Good code is red in injected kotlin language snippets
203203
2. [KT-16802](https://youtrack.jetbrains.com/issue/KT-16802) Good code is always red when editing kts-script files under Kotlin v1.1

0 commit comments

Comments
 (0)