Skip to content

Commit dcb51f9

Browse files
koshachyEkaterina.Volodko
and
Ekaterina.Volodko
authored
update: update docs for the new WebHelp engine (#2393)
* update: update cancellation-and-timeouts.md * update: update channels.md * update: update composing-suspending-functions.md * update: update coroutine-context-and-dispatchers.md * update: update coroutines-guide.md * update: update exception-handling.md * update: update select-expression.md * update: update shared-mutable-state-and-concurrency.md * update: update basics.md * update: update flow.md * update: update flow.md * update: update _nav.yml * update: add _nav.tree * update: update links * update: fixes after review * update: get rid of divs * update: add new lines for WebHelp parser * update: add new lines for WebHelp parser * fix: fix knit errors * removed _nav.yml; * renamed _nav.tree to kc.tree. * removed coroutines overview from the list; a title for a hands-on tutorial * update: Made kc.tree as valid XML * update: added a configuration file project.ihp * update: added a configuration file buildprofiles.xml * update: moved coroutines overview from the main repository * update: update cancellation-and-timeouts.md * update: update channels.md * update: update composing-suspending-functions.md * update: update coroutine-context-and-dispatchers.md * update: update coroutines-guide.md * update: update exception-handling.md * update: update select-expression.md * update: update shared-mutable-state-and-concurrency.md * update: update basics.md * update: update flow.md * update: update flow.md * update: update _nav.yml * update: add _nav.tree * update: update links * update: fixes after review * update: get rid of divs * removed _nav.yml; * renamed _nav.tree to kc.tree. * removed coroutines overview from the list; a title for a hands-on tutorial * update: Made kc.tree as valid XML * update: added a configuration file project.ihp * update: added a configuration file buildprofiles.xml * update: moved coroutines overview from the main repository * update: move debug tutorials to coroutines repository * update: update after knit * update: move all docs files to topics/ * update: corrected the xml version of project.ihp * update: move old jvm tutorial coroutines-basic-jvm.md * update: moved knit.properties to resolve relative path correctly * update: add stubs for moved pages * update: update README.md Co-authored-by: Ekaterina.Volodko <[email protected]>
1 parent 6854be1 commit dcb51f9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+6866
-6806
lines changed

CHANGES.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -237,12 +237,12 @@ Gradle version 5.3 or later to use this version of kotlinx.coroutines in your Ko
237237
This version is the first stable release with [`Flow`](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html) API.
238238

239239
All `Flow` API not marked with `@FlowPreview` or `@ExperimentalCoroutinesApi` annotations are stable and here to stay.
240-
Flow declarations marked with `@ExperimentalCoroutinesApi` have [the same guarantees](/docs/compatibility.md#experimental-api) as regular experimental API.
241-
Please note that API marked with `@FlowPreview` have [weak guarantees](/docs/compatibility.md#flow-preview-api) on source, binary and semantic compatibility.
240+
Flow declarations marked with `@ExperimentalCoroutinesApi` have [the same guarantees](/docs/topics/compatibility.md#experimental-api) as regular experimental API.
241+
Please note that API marked with `@FlowPreview` have [weak guarantees](/docs/topics/compatibility.md#flow-preview-api) on source, binary and semantic compatibility.
242242

243243
### Changelog
244244

245-
* A new [guide section](/docs/flow.md) about Flow.
245+
* A new [guide section](/docs/topics/flow.md) about Flow.
246246
* `CoroutineDispatcher.asExecutor` extension (#1450).
247247
* Fixed bug when `select` statement could report the same exception twice (#1433).
248248
* Fixed context preservation in `flatMapMerge` in a case when collected values were immediately emitted to another flow (#1440).
@@ -383,11 +383,11 @@ A lot of `Flow` improvements:
383383
* `flatMap`, `merge` and `concatenate` are replaced with `flattenConcat`, `flattenMerge`, `flatMapConcat` and `flatMapMerge`.
384384
* Various documentation improvements and minor bug fixes.
385385

386-
Note that `Flow` **is not** leaving its [preview status](/docs/compatibility.md#flow-preview-api).
386+
Note that `Flow` **is not** leaving its [preview status](/docs/topics/compatibility.md#flow-preview-api).
387387

388388
## Version 1.2.0-alpha-2
389389

390-
This release contains major [feature preview](/docs/compatibility.md#flow-preview-api): cold streams aka `Flow` (#254).
390+
This release contains major [feature preview](/docs/topics/compatibility.md#flow-preview-api): cold streams aka `Flow` (#254).
391391

392392
Performance:
393393
* Performance of `Dispatcher.Main` initialization is significantly improved (#878).
@@ -510,7 +510,7 @@ Maintenance release:
510510
* `Job()` wih parent now also cancels parent on failure consistently with other scopes.
511511
* All coroutine builders and `Job` implementations propagate failure to the parent unless it is a `CancellationException`.
512512
* Note, "scoping" builders don't "cancel the parent" verbatim, but rethrow the corresponding exception to the caller for handling.
513-
* `SupervisorJob()` and `supervisorScope { ... }` are introduced, allowing for a flexible implementation of custom exception-handling policies, see a [new section in the guide on supervision](docs/exception-handling.md#supervision).
513+
* `SupervisorJob()` and `supervisorScope { ... }` are introduced, allowing for a flexible implementation of custom exception-handling policies, see a [new section in the guide on supervision](docs/topics/exception-handling.md#supervision).
514514
* Got rid of `awaitAll` in documentation and rewrote `currentScope` section (see #624).
515515
* **[Major]** Coroutine scheduler is used for `Dispatchers.Default` by default instead of deprecated `CommonPool`.
516516
* "`DefaultDispatcher`" is used as a public name of the default impl (you'll see it thread names and in the guide).
@@ -569,7 +569,7 @@ Visible consequences of include more robust exception handling for large corouti
569569
* `currentScope` and `coroutineScope` builders are introduced to extract and provide `CoroutineScope`.
570570
* Factory methods to create `CoroutineScope` from `CoroutineContext` are introduced.
571571
* `CoroutineScope.isActive` became an extension property.
572-
* New sections about structured concurrency in core guide: ["Structured concurrency"](docs/coroutines-guide.md#structured-concurrency), ["Scope builder"](docs/coroutines-guide.md#scope-builder) and ["Structured concurrency with async"](docs/coroutines-guide.md#structured-concurrency-with-async).
572+
* New sections about structured concurrency in core guide: ["Structured concurrency"](docs/topics/coroutines-guide.md#structured-concurrency), ["Scope builder"](docs/topics/coroutines-guide.md#scope-builder) and ["Structured concurrency with async"](docs/topics/coroutines-guide.md#structured-concurrency-with-async).
573573
* New section in UI guide with Android example: ["Structured concurrency, lifecycle and coroutine parent-child hierarchy"](ui/coroutines-guide-ui.md#structured-concurrency,-lifecycle-and-coroutine-parent-child-hierarchy).
574574
* Deprecated reactive API is removed.
575575
* Dispatchers are renamed and grouped in the Dispatchers object (see #41 and #533):
@@ -589,7 +589,7 @@ Visible consequences of include more robust exception handling for large corouti
589589
## Version 0.25.0
590590

591591
* Major rework on exception-handling and cancellation in coroutines (see #333, #452 and #451):
592-
* New ["Exception Handling" section in the guide](docs/coroutines-guide.md#exception-handling) explains exceptions in coroutines.
592+
* New ["Exception Handling" section in the guide](docs/topics/coroutines-guide.md#exception-handling) explains exceptions in coroutines.
593593
* Semantics of `Job.cancel` resulting `Boolean` value changed &mdash; `true` means exception was handled by the job, caller shall handle otherwise.
594594
* Exceptions are properly propagated from children to parents.
595595
* Installed `CoroutineExceptionHandler` for a family of coroutines receives one aggregated exception in case of failure.
@@ -598,7 +598,7 @@ Visible consequences of include more robust exception handling for large corouti
598598
* Introduced support for thread-local elements in coroutines context (see #119):
599599
* `ThreadContextElement` API for custom thread-context sensitive context elements.
600600
* `ThreadLocal.asContextElement()` extension function to convert an arbitrary thread-local into coroutine context element.
601-
* New ["Thread-local data" subsection in the guide](docs/coroutines-guide.md#thread-local-data) with examples.
601+
* New ["Thread-local data" subsection in the guide](docs/topics/coroutines-guide.md#thread-local-data) with examples.
602602
* SLF4J Mapped Diagnostic Context (MDC) integration is provided via `MDCContext` element defined in [`kotlinx-coroutines-slf4j`](integration/kotlinx-coroutines-slf4j/README.md) integration module.
603603
* Introduced IO dispatcher to offload blocking I/O-intensive tasks (see #79).
604604
* Introduced `ExecutorCoroutineDispatcher` instead of `CloseableCoroutineDispatcher` (see #385).
@@ -831,7 +831,7 @@ Visible consequences of include more robust exception handling for large corouti
831831
* Fixed `actor` and `produce` so that a cancellation of a Job cancels the underlying channel (closes and removes all the pending messages).
832832
* Fixed sporadic failure of `example-context-06` (see #160)
833833
* Fixed hang of `Job.start` on lazy coroutine with attached `invokeOnCompletion` handler.
834-
* A more gradual introduction to `runBlocking` and coroutines in the [guide](docs/coroutines-guide.md) (see #166).
834+
* A more gradual introduction to `runBlocking` and coroutines in the [guide](docs/topics/coroutines-guide.md) (see #166).
835835

836836
## Version 0.19.3
837837

@@ -882,7 +882,7 @@ Visible consequences of include more robust exception handling for large corouti
882882
* When a context is explicitly specified, `newCoroutineContext` function checks if there is any
883883
interceptor/dispatcher defined in the context and uses `DefaultDispatcher` if there is none.
884884
* `DefaultDispatcher` is currently defined to be equal to `CommonPool`.
885-
* Examples in the [guide](docs/coroutines-guide.md) now start with `launch { ... }` code and explanation on the nature
885+
* Examples in the [guide](docs/topics/coroutines-guide.md) now start with `launch { ... }` code and explanation on the nature
886886
and the need for coroutine context starts in "Coroutine context and dispatchers" section.
887887
* Parent coroutines now wait for their children (see #125):
888888
* Job _completing_ state is introduced in documentation as a state in which parent coroutine waits for its children.
@@ -942,7 +942,7 @@ Visible consequences of include more robust exception handling for large corouti
942942
## Version 0.17
943943

944944
* `CompletableDeferred` is introduced as a set-once event-like communication primitive (see #70).
945-
* [Coroutines guide](docs/coroutines-guide.md) uses it in a section on actors.
945+
* [Coroutines guide](docs/topics/coroutines-guide.md) uses it in a section on actors.
946946
* `CompletableDeferred` is an interface with private impl (courtesy of @fvasco, see #86).
947947
* It extends `Deferred` interface with `complete` and `completeExceptionally` functions.
948948
* `Job.join` and `Deferred.await` wait until a cancelled coroutine stops execution (see #64).
@@ -1088,15 +1088,15 @@ Visible consequences of include more robust exception handling for large corouti
10881088
* `actor` coroutine builder.
10891089
* Couple more examples for "Shared mutable state and concurrency" section and
10901090
"Channels are fair" section with ping-pong table example
1091-
in [coroutines guide](docs/coroutines-guide.md).
1091+
in [coroutines guide](docs/topics/coroutines-guide.md).
10921092

10931093
## Version 0.11-rc
10941094

10951095
* `select` expression with onJoin/onAwait/onSend/onReceive clauses.
10961096
* `Mutex` is moved to `kotlinx.coroutines.sync` package.
10971097
* `ClosedSendChannelException` is a subclass of `CancellationException` now.
10981098
* New sections on "Shared mutable state and concurrency" and "Select expression"
1099-
in [coroutines guide](docs/coroutines-guide.md).
1099+
in [coroutines guide](docs/topics/coroutines-guide.md).
11001100

11011101
## Version 0.10-rc
11021102

@@ -1124,20 +1124,20 @@ Visible consequences of include more robust exception handling for large corouti
11241124
So, lazy coroutines do not need a separate state variable to track their started/not-started (new/active) status.
11251125
* Exception transparency in `Job.cancel` (original cause is rethrown).
11261126
* Clarified possible states for `Job`/`CancellableContinuation`/`Deferred` in docs.
1127-
* Example on async-style functions and links to API reference site from [coroutines guide](docs/coroutines-guide.md).
1127+
* Example on async-style functions and links to API reference site from [coroutines guide](docs/topics/coroutines-guide.md).
11281128

11291129
## Version 0.7-beta
11301130

11311131
* Buffered and unbuffered channels are introduced: `Channel`, `SendChannel`, and `ReceiveChannel` interfaces,
11321132
`RendezvousChannel` and `ArrayChannel` implementations, `Channel()` factory function and `buildChannel{}`
11331133
coroutines builder.
11341134
* `Here` context is renamed to `Unconfined` (the old name is deprecated).
1135-
* A [guide on coroutines](docs/coroutines-guide.md) is expanded: sections on contexts and channels.
1135+
* A [guide on coroutines](docs/topics/coroutines-guide.md) is expanded: sections on contexts and channels.
11361136

11371137
## Version 0.6-beta
11381138

11391139
* Switched to Kotlin version 1.1.0-beta-37.
1140-
* A [guide on coroutines](docs/coroutines-guide.md) is expanded.
1140+
* A [guide on coroutines](docs/topics/coroutines-guide.md) is expanded.
11411141

11421142
## Version 0.5-beta
11431143

@@ -1150,7 +1150,7 @@ Visible consequences of include more robust exception handling for large corouti
11501150
has a default implementation that returns `true`.
11511151
* `NonCancellable` context is introduced.
11521152
* Performance optimizations for cancellable continuations (fewer objects created).
1153-
* A [guide on coroutines](docs/coroutines-guide.md) is added.
1153+
* A [guide on coroutines](docs/topics/coroutines-guide.md) is added.
11541154

11551155
## Version 0.4-beta
11561156

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,10 @@ suspend fun main() = coroutineScope {
6565
* [Deep dive into Coroutines](https://www.youtube.com/watch?v=YrrUCSi72E8) (Roman Elizarov at KotlinConf 2017, [slides](https://www.slideshare.net/elizarov/deep-dive-into-coroutines-on-jvm-kotlinconf-2017))
6666
* [Kotlin Coroutines in Practice](https://www.youtube.com/watch?v=a3agLJQ6vt8) (Roman Elizarov at KotlinConf 2018, [slides](https://www.slideshare.net/elizarov/kotlin-coroutines-in-practice-kotlinconf-2018))
6767
* Guides and manuals:
68-
* [Guide to kotlinx.coroutines by example](https://kotlinlang.org/docs/reference/coroutines/coroutines-guide.html) (**read it first**)
68+
* [Guide to kotlinx.coroutines by example](https://kotlinlang.org/docs/coroutines-guide.html) (**read it first**)
6969
* [Guide to UI programming with coroutines](ui/coroutines-guide-ui.md)
70-
* [Debugging capabilities in kotlinx.coroutines](docs/debugging.md)
71-
* [Compatibility policy and experimental annotations](docs/compatibility.md)
70+
* [Debugging capabilities in kotlinx.coroutines](docs/topics/debugging.md)
71+
* [Compatibility policy and experimental annotations](docs/topics/compatibility.md)
7272
* [Change log for kotlinx.coroutines](CHANGES.md)
7373
* [Coroutines design document (KEEP)](https://github.com/Kotlin/KEEP/blob/master/proposals/coroutines.md)
7474
* [Full kotlinx.coroutines API reference](https://kotlin.github.io/kotlinx.coroutines)
@@ -190,15 +190,15 @@ packagingOptions {
190190

191191
### JS
192192

193-
[Kotlin/JS](https://kotlinlang.org/docs/reference/js-overview.html) version of `kotlinx.coroutines` is published as
193+
[Kotlin/JS](https://kotlinlang.org/docs/js-overview.html) version of `kotlinx.coroutines` is published as
194194
[`kotlinx-coroutines-core-js`](https://search.maven.org/artifact/org.jetbrains.kotlinx/kotlinx-coroutines-core-js/1.4.2/jar)
195195
(follow the link to get the dependency declaration snippet).
196196

197197
You can also use [`kotlinx-coroutines-core`](https://www.npmjs.com/package/kotlinx-coroutines-core) package via NPM.
198198

199199
### Native
200200

201-
[Kotlin/Native](https://kotlinlang.org/docs/reference/native-overview.html) version of `kotlinx.coroutines` is published as
201+
[Kotlin/Native](https://kotlinlang.org/docs/native-overview.html) version of `kotlinx.coroutines` is published as
202202
[`kotlinx-coroutines-core-native`](https://search.maven.org/artifact/org.jetbrains.kotlinx/kotlinx-coroutines-core-native/1.4.2/jar)
203203
(follow the link to get the dependency declaration snippet).
204204

0 commit comments

Comments
 (0)