Skip to content

Commit cd6048e

Browse files
authored
Writerside markdown migration (#4457)
* Update compatibility-guide-17.md * Update compatibility-guide-18.md * Update compatibility-guide-19.md * Update generics.md * Update generics.md * Update generics.md * Update gradle-compiler-options.md * Update k2-compiler-migration-guide.md * Update multiplatform-compatibility-guide.md * Update whatsnew17.md * Update compiler-reference.md * Update js-to-kotlin-interop.md * Update generics.md
1 parent d60dbb8 commit cd6048e

10 files changed

+21
-21
lines changed

docs/topics/compatibility-guides/compatibility-guide-17.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -421,7 +421,7 @@ perspective
421421
> **Deprecation cycle:**
422422
>
423423
> - 1.7.0: raise the deprecation level to a warning
424-
> - \> 1.7.0: remove the property
424+
> - > 1.7.0: remove the property
425425
426426
### Remove kotlinOptions.jdkHome compiler option
427427

@@ -437,7 +437,7 @@ perspective
437437
> **Deprecation cycle:**
438438
>
439439
> - 1.5.30: raise the deprecation level to a warning
440-
> - \> 1.7.0: remove the option
440+
> - > 1.7.0: remove the option
441441
442442
### Remove noStdlib compiler option
443443

@@ -487,4 +487,4 @@ perspective
487487
>
488488
> **Deprecation cycle:**
489489
>
490-
> - 1.7.0: inputs are not available, the output is replaced, the `classpath` property is deprecated
490+
> - 1.7.0: inputs are not available, the output is replaced, the `classpath` property is deprecated

docs/topics/compatibility-guides/compatibility-guide-18.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -638,4 +638,4 @@ perspective
638638
> **Deprecation cycle:**
639639
>
640640
> - 1.8.0: raise the deprecation level to a warning
641-
> \>= 1.9: delete the property
641+
> >= 1.9: delete the property

docs/topics/compatibility-guides/compatibility-guide-19.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -551,4 +551,4 @@ perspective
551551
> **Deprecation cycle:**
552552
>
553553
> * 1.8.0: raise the deprecation level to a warning
554-
> * \>= 1.9: delete the property
554+
> * >= 1.9: delete the property

docs/topics/compiler-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ their names and behavior may be changed without notice.
7777
7878
Specify a custom path to the Kotlin compiler used for the discovery of runtime libraries.
7979
80-
### -P plugin:_pluginId_:_optionName_=_value_
80+
### -P plugin:pluginId:optionName=value
8181
8282
Pass an option to a Kotlin compiler plugin.
8383
Available plugins and their options are listed in the **Tools > Compiler plugins** section of the documentation.

docs/topics/generics.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ _or a subtype of_ `E`, not just `E` itself. This means that you can safely _read
8686
(elements of this collection are instances of a subclass of E), but _cannot write_ to
8787
it as you don't know what objects comply with that unknown subtype of `E`.
8888
In return for this limitation, you get the desired behavior: `Collection<String>` _is_ a subtype of `Collection<? extends Object>`.
89-
In other words, the wildcard with an _extends_\-bound (_upper_ bound) makes the type _covariant_.
89+
In other words, the wildcard with an _extends_-bound (_upper_ bound) makes the type _covariant_.
9090

9191
The key to understanding why this works is rather simple: if you can only _take_ items from a collection,
9292
then using a collection of `String`s and reading `Object`s from it is fine. Conversely, if you can only _put_ items
@@ -183,7 +183,7 @@ fun demo(x: Comparable<Number>) {
183183
The words _in_ and _out_ seem to be self-explanatory (as they've already been used successfully in C# for quite some time),
184184
and so the mnemonic mentioned above is not really needed. It can in fact be rephrased at a higher level of abstraction:
185185

186-
**[The Existential](https://en.wikipedia.org/wiki/Existentialism) Transformation: Consumer in, Producer out\!** :-)
186+
**[The Existential](https://en.wikipedia.org/wiki/Existentialism) Transformation: Consumer in, Producer out!** :-)
187187

188188
## Type projections
189189

@@ -314,7 +314,7 @@ sort(listOf(HashMap<Int, String>())) // Error: HashMap<Int, String> is not a sub
314314
```
315315

316316
The default upper bound (if there was none specified) is `Any?`. Only one upper bound can be specified inside the angle brackets.
317-
If the same type parameter needs more than one upper bound, you need a separate _where_\-clause:
317+
If the same type parameter needs more than one upper bound, you need a separate _where_-clause:
318318

319319
```kotlin
320320
fun <T> copyWhenGreater(list: List<T>, threshold: T): List<String>

docs/topics/gradle/gradle-compiler-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ Also, see [Types for compiler options](#types-for-compiler-options).
280280
| `main` | Define whether the `main` function should be called upon execution | "call", "noCall". Also, see [Types for compiler options](#types-for-compiler-options) | "call" |
281281
| `metaInfo` | Generate .meta.js and .kjsm files with metadata. Use to create a library | | true |
282282
| `moduleKind` | The kind of JS module generated by the compiler | "umd", "commonjs", "amd", "plain", "es". Also, see [Types for compiler options](#types-for-compiler-options) | "umd" |
283-
| `outputFile` | Destination *.js file for the compilation result | | "\<buildDir>/js/packages/\<project.name>/kotlin/\<project.name>.js" |
283+
| `outputFile` | Destination *.js file for the compilation result | | "<buildDir>/js/packages/<project.name>/kotlin/<project.name>.js" |
284284
| `sourceMap` | Generate source map | | true |
285285
| `sourceMapEmbedSources` | Embed source files into the source map | "never", "always", "inlining". Also, see [Types for compiler options](#types-for-compiler-options) | |
286286
| `sourceMapNamesPolicy` | Add variable and function names that you declared in Kotlin code into the source map. For more information on the behavior, see our [compiler reference](compiler-reference.md#source-map-names-policy-simple-names-fully-qualified-names-no). | "simple-names", "fully-qualified-names", "no". Also, see [Types for compiler options](#types-for-compiler-options) | "simple-names" |

docs/topics/js/js-to-kotlin-interop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ See how Kotlin types are mapped to JavaScript ones:
182182
| `Unit` | Undefined | Exportable when used as return type, but not when used as parameter type. |
183183
| `Any` | `Object` | |
184184
| `Throwable` | `Error` | |
185-
| Nullable `Type?` | `Type | null | undefined` | |
185+
| Nullable `Type?` | `Type | null | undefined` | |
186186
| All other Kotlin types (except for those marked with `JsExport` annotation) | Not supported | Includes Kotlin's [unsigned integer types](unsigned-integer-types.md). |
187187

188188
Additionally, it is important to know that:

docs/topics/k2-compiler-migration-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1274,7 +1274,7 @@ for further reading. Changes listed with an asterisk (*) next to the Issue ID ar
12741274
| [KT-55111](https://youtrack.jetbrains.com/issue/KT-55111) | OptIn: forbid constructor calls with default arguments under marker |
12751275
| [KT-61182](https://youtrack.jetbrains.com/issue/KT-61182) | Unit conversion is accidentally allowed to be used for expressions on variables + invoke resolution |
12761276
| [KT-55199](https://youtrack.jetbrains.com/issue/KT-55199) | Forbid promoting callable references with adaptations to KFunction |
1277-
| [KT-65776](https://youtrack.jetbrains.com/issue/KT-65776) | [LC] K2 breaks \`false && ...\` and \`false \|\| ...\` |
1277+
| [KT-65776](https://youtrack.jetbrains.com/issue/KT-65776) | [LC] K2 breaks \`false && ...\` and \`false || ...\` |
12781278
| [KT-65682](https://youtrack.jetbrains.com/issue/KT-65682) | [LC] Deprecate \`header\`/\`impl\` keywords |
12791279
| [KT-45375](https://youtrack.jetbrains.com/issue/KT-45375) | Generate all Kotlin lambdas via invokedynamic + LambdaMetafactory by default |
12801280

@@ -1350,4 +1350,4 @@ We would appreciate any feedback you may have!
13501350

13511351
* Report any problems you face migrating to the new K2 compiler in [our issue tracker](https://youtrack.jetbrains.com/newIssue?project=KT&summary=K2+release+migration+issue&description=Describe+the+problem+you+encountered+here.&c=tag+k2-release-migration).
13521352
* [Enable the Send usage statistics option](https://www.jetbrains.com/help/idea/settings-usage-statistics.html) to
1353-
allow JetBrains to collect anonymous data about K2 usage.
1353+
allow JetBrains to collect anonymous data about K2 usage.

docs/topics/multiplatform/multiplatform-compatibility-guide.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@ Here's the planned deprecation cycle:
406406

407407
* 1.9: introduce a deprecation warning for dependencies on legacy libraries
408408
* 2.0: raise the warning for dependencies on legacy libraries to an error
409-
* \>2.0: remove support for dependencies on legacy libraries; using such dependencies can cause build failures
409+
* &gt;2.0: remove support for dependencies on legacy libraries; using such dependencies can cause build failures
410410

411411
<anchor name="compilation-source-deprecation"/>
412412
## Deprecated API for adding Kotlin source sets directly to the Kotlin compilation
@@ -472,7 +472,7 @@ Here's the planned deprecation cycle:
472472

473473
* 1.9.0: introduce a deprecation warning when `KotlinComplation.source` is used
474474
* 1.9.20: raise this warning to an error
475-
* \>1.9.20: remove `KotlinComplation.source` from the Kotlin Gradle plugin, attempts to use it lead to "unresolved
475+
* &gt;1.9.20: remove `KotlinComplation.source` from the Kotlin Gradle plugin, attempts to use it lead to "unresolved
476476
reference" errors during the buildscript compilation
477477

478478
<anchor name="kotlin-js-plugin-deprecation"/>
@@ -787,7 +787,7 @@ Here's the planned deprecation cycle:
787787
788788
* 1.3.40: introduce a warning when `targetPresets.jvmWithJava` is used
789789
* 1.9.20: raise this warning to an error
790-
* \>1.9.20: remove `targetPresets.jvmWithJava` API; attempts to use it lead to the buildscript compilation failure
790+
* &gt;1.9.20: remove `targetPresets.jvmWithJava` API; attempts to use it lead to the buildscript compilation failure
791791
792792
> Even though the whole `targetPresets` API is deprecated, the `jvmWithJava` preset has a different deprecation timeline.
793793
>
@@ -809,7 +809,7 @@ Here's the planned deprecation cycle:
809809
* <=1.9.0: report a warning when `kotlin.mpp.androidSourceSetLayoutVersion=1` is used; the warning can be suppressed with
810810
`kotlin.mpp.androidSourceSetLayoutVersion1.nowarn=true` Gradle property
811811
* 1.9.20: raise this warning to an error; the error **cannot** be suppressed
812-
* \>1.9.20: remove support for `kotlin.mpp.androidSourceSetLayoutVersion=1`; the Kotlin Gradle plugin ignores the property
812+
* &gt;1.9.20: remove support for `kotlin.mpp.androidSourceSetLayoutVersion=1`; the Kotlin Gradle plugin ignores the property
813813
814814
<anchor name="common-sourceset-with-dependson-deprecation"/>
815815
## Deprecated commonMain and commonTest with custom dependsOn
@@ -847,7 +847,7 @@ to `commonMain` and vice versa.
847847
Here's the planned deprecation cycle:
848848
849849
* 1.9.0: report a warning when `dependsOn` is used in `commonMain`
850-
* \>=1.9.20: report an error when `dependsOn` is used in `commonMain` or `commonTest`
850+
* &gt;=1.9.20: report an error when `dependsOn` is used in `commonMain` or `commonTest`
851851
852852
<anchor name="target-presets-deprecation"/>
853853
## Deprecated target presets API
@@ -905,7 +905,7 @@ Here's the planned deprecation cycle:
905905

906906
* 1.9.20: report a warning on any usages of the presets-related API
907907
* 2.0: raise this warning to an error
908-
* \>2.0: remove the presets-related API from the public API of the Kotlin Gradle plugin; sources that still use it fail
908+
* &gt;2.0: remove the presets-related API from the public API of the Kotlin Gradle plugin; sources that still use it fail
909909
with "unresolved reference" errors, and binaries (for example, Gradle plugins) might fail with linkage errors
910910
unless recompiled against the latest versions of the Kotlin Gradle plugin
911911

@@ -1002,4 +1002,4 @@ version of the iOS framework. So, the changes won't be visible in the iOS app in
10021002
We're planning to fix this issue in Kotlin 2.0.10. You can check if any preview versions of
10031003
Kotlin 2.0.10 are already available in the [Participate in the Kotlin Early Access Preview](eap.md) section.
10041004

1005-
For more information, see the [corresponding issue in YouTrack](https://youtrack.jetbrains.com/issue/KT-68257).
1005+
For more information, see the [corresponding issue in YouTrack](https://youtrack.jetbrains.com/issue/KT-68257).

docs/topics/whatsnew17.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -525,7 +525,7 @@ compatibility, see [Compatibility modes](compatibility-modes.md).
525525

526526
### Access to annotations via reflection
527527

528-
The `KAnnotatedElement.[findAnnotations()](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect.full/find-annotations.html)`
528+
The [`KAnnotatedElement.findAnnotations()`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect.full/find-annotations.html)
529529
extension function, which was first [introduced in 1.6.0](whatsnew16.md#repeatable-annotations-with-runtime-retention-for-1-8-jvm-target),
530530
is now [Stable](components-stability.md). This [reflection](reflection.md)
531531
function returns all annotations of a given type on an element, including individually applied and repeated annotations.

0 commit comments

Comments
 (0)