Skip to content

Commit 1f4d71d

Browse files
committed
Consistent chapter naming and ordering in docs
1 parent a6da28e commit 1f4d71d

9 files changed

+42
-42
lines changed

coroutines-guide.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ The main coroutines guide has moved to the [docs folder](docs/coroutines-guide.m
33
## Table of contents
44

55
<!--- TOC_REF docs/basics.md -->
6-
* <a name='coroutine-basics'></a>[Coroutine basics](docs/basics.md#coroutine-basics)
6+
* <a name='coroutine-basics'></a>[Coroutine Basics](docs/basics.md#coroutine-basics)
77
* <a name='your-first-coroutine'></a>[Your first coroutine](docs/basics.md#your-first-coroutine)
88
* <a name='bridging-blocking-and-non-blocking-worlds'></a>[Bridging blocking and non-blocking worlds](docs/basics.md#bridging-blocking-and-non-blocking-worlds)
99
* <a name='waiting-for-a-job'></a>[Waiting for a job](docs/basics.md#waiting-for-a-job)
@@ -13,22 +13,22 @@ The main coroutines guide has moved to the [docs folder](docs/coroutines-guide.m
1313
* <a name='coroutines-are-light-weight'></a>[Coroutines ARE light-weight](docs/basics.md#coroutines-are-light-weight)
1414
* <a name='global-coroutines-are-like-daemon-threads'></a>[Global coroutines are like daemon threads](docs/basics.md#global-coroutines-are-like-daemon-threads)
1515
<!--- TOC_REF docs/cancellation-and-timeouts.md -->
16-
* <a name='cancellation-and-timeouts'></a>[Cancellation and timeouts](docs/cancellation-and-timeouts.md#cancellation-and-timeouts)
16+
* <a name='cancellation-and-timeouts'></a>[Cancellation and Timeouts](docs/cancellation-and-timeouts.md#cancellation-and-timeouts)
1717
* <a name='cancelling-coroutine-execution'></a>[Cancelling coroutine execution](docs/cancellation-and-timeouts.md#cancelling-coroutine-execution)
1818
* <a name='cancellation-is-cooperative'></a>[Cancellation is cooperative](docs/cancellation-and-timeouts.md#cancellation-is-cooperative)
1919
* <a name='making-computation-code-cancellable'></a>[Making computation code cancellable](docs/cancellation-and-timeouts.md#making-computation-code-cancellable)
2020
* <a name='closing-resources-with-finally'></a>[Closing resources with `finally`](docs/cancellation-and-timeouts.md#closing-resources-with-finally)
2121
* <a name='run-non-cancellable-block'></a>[Run non-cancellable block](docs/cancellation-and-timeouts.md#run-non-cancellable-block)
2222
* <a name='timeout'></a>[Timeout](docs/cancellation-and-timeouts.md#timeout)
2323
<!--- TOC_REF docs/composing-suspending-functions.md -->
24-
* <a name='composing-suspending-functions'></a>[Composing suspending functions](docs/composing-suspending-functions.md#composing-suspending-functions)
24+
* <a name='composing-suspending-functions'></a>[Composing Suspending Functions](docs/composing-suspending-functions.md#composing-suspending-functions)
2525
* <a name='sequential-by-default'></a>[Sequential by default](docs/composing-suspending-functions.md#sequential-by-default)
2626
* <a name='concurrent-using-async'></a>[Concurrent using async](docs/composing-suspending-functions.md#concurrent-using-async)
2727
* <a name='lazily-started-async'></a>[Lazily started async](docs/composing-suspending-functions.md#lazily-started-async)
2828
* <a name='async-style-functions'></a>[Async-style functions](docs/composing-suspending-functions.md#async-style-functions)
2929
* <a name='structured-concurrency-with-async'></a>[Structured concurrency with async](docs/composing-suspending-functions.md#structured-concurrency-with-async)
3030
<!--- TOC_REF docs/coroutine-context-and-dispatchers.md -->
31-
* <a name='coroutine-context-and-dispatchers'></a>[Coroutine context and dispatchers](docs/coroutine-context-and-dispatchers.md#coroutine-context-and-dispatchers)
31+
* <a name='coroutine-context-and-dispatchers'></a>[Coroutine Context and Dispatchers](docs/coroutine-context-and-dispatchers.md#coroutine-context-and-dispatchers)
3232
* <a name='dispatchers-and-threads'></a>[Dispatchers and threads](docs/coroutine-context-and-dispatchers.md#dispatchers-and-threads)
3333
* <a name='unconfined-vs-confined-dispatcher'></a>[Unconfined vs confined dispatcher](docs/coroutine-context-and-dispatchers.md#unconfined-vs-confined-dispatcher)
3434
* <a name='debugging-coroutines-and-threads'></a>[Debugging coroutines and threads](docs/coroutine-context-and-dispatchers.md#debugging-coroutines-and-threads)
@@ -40,16 +40,6 @@ The main coroutines guide has moved to the [docs folder](docs/coroutines-guide.m
4040
* <a name='combining-context-elements'></a>[Combining context elements](docs/coroutine-context-and-dispatchers.md#combining-context-elements)
4141
* <a name='coroutine-scope'></a>[Coroutine scope](docs/coroutine-context-and-dispatchers.md#coroutine-scope)
4242
* <a name='thread-local-data'></a>[Thread-local data](docs/coroutine-context-and-dispatchers.md#thread-local-data)
43-
<!--- TOC_REF docs/exception-handling.md -->
44-
* <a name='exception-handling'></a>[Exception handling](docs/exception-handling.md#exception-handling)
45-
* <a name='exception-propagation'></a>[Exception propagation](docs/exception-handling.md#exception-propagation)
46-
* <a name='coroutineexceptionhandler'></a>[CoroutineExceptionHandler](docs/exception-handling.md#coroutineexceptionhandler)
47-
* <a name='cancellation-and-exceptions'></a>[Cancellation and exceptions](docs/exception-handling.md#cancellation-and-exceptions)
48-
* <a name='exceptions-aggregation'></a>[Exceptions aggregation](docs/exception-handling.md#exceptions-aggregation)
49-
* <a name='supervision'></a>[Supervision](docs/exception-handling.md#supervision)
50-
* <a name='supervision-job'></a>[Supervision job](docs/exception-handling.md#supervision-job)
51-
* <a name='supervision-scope'></a>[Supervision scope](docs/exception-handling.md#supervision-scope)
52-
* <a name='exceptions-in-supervised-coroutines'></a>[Exceptions in supervised coroutines](docs/exception-handling.md#exceptions-in-supervised-coroutines)
5343
<!--- TOC_REF docs/channels.md -->
5444
* <a name='channels'></a>[Channels](docs/channels.md#channels)
5545
* <a name='channel-basics'></a>[Channel basics](docs/channels.md#channel-basics)
@@ -62,6 +52,16 @@ The main coroutines guide has moved to the [docs folder](docs/coroutines-guide.m
6252
* <a name='buffered-channels'></a>[Buffered channels](docs/channels.md#buffered-channels)
6353
* <a name='channels-are-fair'></a>[Channels are fair](docs/channels.md#channels-are-fair)
6454
* <a name='ticker-channels'></a>[Ticker channels](docs/channels.md#ticker-channels)
55+
<!--- TOC_REF docs/exception-handling.md -->
56+
* <a name='exception-handling'></a>[Exception Handling](docs/exception-handling.md#exception-handling)
57+
* <a name='exception-propagation'></a>[Exception propagation](docs/exception-handling.md#exception-propagation)
58+
* <a name='coroutineexceptionhandler'></a>[CoroutineExceptionHandler](docs/exception-handling.md#coroutineexceptionhandler)
59+
* <a name='cancellation-and-exceptions'></a>[Cancellation and exceptions](docs/exception-handling.md#cancellation-and-exceptions)
60+
* <a name='exceptions-aggregation'></a>[Exceptions aggregation](docs/exception-handling.md#exceptions-aggregation)
61+
* <a name='supervision'></a>[Supervision](docs/exception-handling.md#supervision)
62+
* <a name='supervision-job'></a>[Supervision job](docs/exception-handling.md#supervision-job)
63+
* <a name='supervision-scope'></a>[Supervision scope](docs/exception-handling.md#supervision-scope)
64+
* <a name='exceptions-in-supervised-coroutines'></a>[Exceptions in supervised coroutines](docs/exception-handling.md#exceptions-in-supervised-coroutines)
6565
<!--- TOC_REF docs/shared-mutable-state-and-concurrency.md -->
6666
* <a name='shared-mutable-state-and-concurrency'></a>[Shared mutable state and concurrency](docs/shared-mutable-state-and-concurrency.md#shared-mutable-state-and-concurrency)
6767
* <a name='the-problem'></a>[The problem](docs/shared-mutable-state-and-concurrency.md#the-problem)
@@ -72,7 +72,7 @@ The main coroutines guide has moved to the [docs folder](docs/coroutines-guide.m
7272
* <a name='mutual-exclusion'></a>[Mutual exclusion](docs/shared-mutable-state-and-concurrency.md#mutual-exclusion)
7373
* <a name='actors'></a>[Actors](docs/shared-mutable-state-and-concurrency.md#actors)
7474
<!--- TOC_REF docs/select-expression.md -->
75-
* <a name='select-expression-experimental'></a>[Select expression (experimental)](docs/select-expression.md#select-expression-experimental)
75+
* <a name='select-expression-experimental'></a>[Select Expression (experimental)](docs/select-expression.md#select-expression-experimental)
7676
* <a name='selecting-from-channels'></a>[Selecting from channels](docs/select-expression.md#selecting-from-channels)
7777
* <a name='selecting-on-close'></a>[Selecting on close](docs/select-expression.md#selecting-on-close)
7878
* <a name='selecting-to-send'></a>[Selecting to send](docs/select-expression.md#selecting-to-send)

docs/_nav.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,21 @@
77
- md: cancellation-and-timeouts.md
88
url: cancellation-and-timeouts.html
99
title: Cancellation and Timeouts
10-
- md: channels.md
11-
url: channels.html
12-
title: Channels
1310
- md: composing-suspending-functions.md
1411
url: composing-suspending-functions.html
1512
title: Composing Suspending Functions
1613
- md: coroutine-context-and-dispatchers.md
1714
url: coroutine-context-and-dispatchers.html
1815
title: Coroutine Context and Dispatchers
16+
- md: channels.md
17+
url: channels.html
18+
title: Channels
1919
- md: exception-handling.md
2020
url: exception-handling.html
21-
title: Exception Handling
22-
- md: select-expression.md
23-
url: select-expression.html
24-
title: Select Expression
21+
title: Exception Handling and Supervision
2522
- md: shared-mutable-state-and-concurrency.md
2623
url: shared-mutable-state-and-concurrency.html
2724
title: Shared Mutable State and Concurrency
25+
- md: select-expression.md
26+
url: select-expression.html
27+
title: Select Expression (experimental)

docs/basics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class BasicsGuideTest {
2020

2121
<!--- TOC -->
2222

23-
* [Coroutine basics](#coroutine-basics)
23+
* [Coroutine Basics](#coroutine-basics)
2424
* [Your first coroutine](#your-first-coroutine)
2525
* [Bridging blocking and non-blocking worlds](#bridging-blocking-and-non-blocking-worlds)
2626
* [Waiting for a job](#waiting-for-a-job)
@@ -33,7 +33,7 @@ class BasicsGuideTest {
3333
<!--- END_TOC -->
3434

3535

36-
## Coroutine basics
36+
## Coroutine Basics
3737

3838
This section covers basic coroutine concepts.
3939

docs/cancellation-and-timeouts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class CancellationTimeOutsGuideTest {
1919

2020
<!--- TOC -->
2121

22-
* [Cancellation and timeouts](#cancellation-and-timeouts)
22+
* [Cancellation and Timeouts](#cancellation-and-timeouts)
2323
* [Cancelling coroutine execution](#cancelling-coroutine-execution)
2424
* [Cancellation is cooperative](#cancellation-is-cooperative)
2525
* [Making computation code cancellable](#making-computation-code-cancellable)
@@ -29,7 +29,7 @@ class CancellationTimeOutsGuideTest {
2929

3030
<!--- END_TOC -->
3131

32-
## Cancellation and timeouts
32+
## Cancellation and Timeouts
3333

3434
This section covers coroutine cancellation and timeouts.
3535

docs/composing-suspending-functions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class ComposingGuideTest {
2020

2121
<!--- TOC -->
2222

23-
* [Composing suspending functions](#composing-suspending-functions)
23+
* [Composing Suspending Functions](#composing-suspending-functions)
2424
* [Sequential by default](#sequential-by-default)
2525
* [Concurrent using async](#concurrent-using-async)
2626
* [Lazily started async](#lazily-started-async)
@@ -29,7 +29,7 @@ class ComposingGuideTest {
2929

3030
<!--- END_TOC -->
3131

32-
## Composing suspending functions
32+
## Composing Suspending Functions
3333

3434
This section covers various approaches to composition of suspending functions.
3535

docs/coroutine-context-and-dispatchers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class DispatchersGuideTest {
2020

2121
<!--- TOC -->
2222

23-
* [Coroutine context and dispatchers](#coroutine-context-and-dispatchers)
23+
* [Coroutine Context and Dispatchers](#coroutine-context-and-dispatchers)
2424
* [Dispatchers and threads](#dispatchers-and-threads)
2525
* [Unconfined vs confined dispatcher](#unconfined-vs-confined-dispatcher)
2626
* [Debugging coroutines and threads](#debugging-coroutines-and-threads)
@@ -35,7 +35,7 @@ class DispatchersGuideTest {
3535

3636
<!--- END_TOC -->
3737

38-
## Coroutine context and dispatchers
38+
## Coroutine Context and Dispatchers
3939

4040
Coroutines always execute in some context represented by a value of the
4141
[CoroutineContext](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/)

docs/coroutines-guide.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ In order to use coroutines as well as follow the examples in this guide, you nee
1515

1616
## Table of contents
1717

18-
* [Coroutine basics](basics.md)
19-
* [Cancellation and timeouts](cancellation-and-timeouts.md)
20-
* [Composing suspending functions](composing-suspending-functions.md)
21-
* [Coroutine context and dispatchers](coroutine-context-and-dispatchers.md)
22-
* [Exception handling and supervision](exception-handling.md)
23-
* [Channels (experimental)](channels.md)
24-
* [Shared mutable state and concurrency](shared-mutable-state-and-concurrency.md)
25-
* [Select expression (experimental)](select-expression.md)
18+
* [Basics](basics.md)
19+
* [Cancellation and Timeouts](cancellation-and-timeouts.md)
20+
* [Composing Suspending Functions](composing-suspending-functions.md)
21+
* [Coroutine Context and Dispatchers](coroutine-context-and-dispatchers.md)
22+
* [Channels](channels.md)
23+
* [Exception Handling and Supervision](exception-handling.md)
24+
* [Shared Mutable State and Concurrency](shared-mutable-state-and-concurrency.md)
25+
* [Select Expression (experimental)](select-expression.md)
2626

2727
## Additional references
2828

docs/exception-handling.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class ExceptionsGuideTest {
1919

2020
<!--- TOC -->
2121

22-
* [Exception handling](#exception-handling)
22+
* [Exception Handling](#exception-handling)
2323
* [Exception propagation](#exception-propagation)
2424
* [CoroutineExceptionHandler](#coroutineexceptionhandler)
2525
* [Cancellation and exceptions](#cancellation-and-exceptions)
@@ -31,7 +31,7 @@ class ExceptionsGuideTest {
3131

3232
<!--- END_TOC -->
3333

34-
## Exception handling
34+
## Exception Handling
3535

3636

3737
This section covers exception handling and cancellation on exceptions.

docs/select-expression.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class SelectGuideTest {
2121

2222
<!--- TOC -->
2323

24-
* [Select expression (experimental)](#select-expression-experimental)
24+
* [Select Expression (experimental)](#select-expression-experimental)
2525
* [Selecting from channels](#selecting-from-channels)
2626
* [Selecting on close](#selecting-on-close)
2727
* [Selecting to send](#selecting-to-send)
@@ -32,7 +32,7 @@ class SelectGuideTest {
3232

3333

3434

35-
## Select expression (experimental)
35+
## Select Expression (experimental)
3636

3737
Select expression makes it possible to await multiple suspending functions simultaneously and _select_
3838
the first one that becomes available.

0 commit comments

Comments
 (0)