Skip to content

minor fix for typo, indent, link, and sample code, etc #4905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/topics/basic-syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ See [Functions](functions.md).

In Kotlin, you declare a variable starting with a keyword, `val` or `var`, followed by the name of the variable.

Use the `val` keyword to declare variables that are assigned a value only once. These are immutable, read-only local variables that cant be reassigned a different value
Use the `val` keyword to declare variables that are assigned a value only once. These are immutable, read-only local variables that can't be reassigned a different value
after initialization:

```kotlin
Expand Down Expand Up @@ -713,4 +713,3 @@ fun main() {
{kotlin-runnable="true" kotlin-min-compiler-version="1.3" id="kotlin-basic-syntax-is-operator-logic"}

See [Classes](classes.md) and [Type casts](typecasts.md).

4 changes: 2 additions & 2 deletions docs/topics/gradle/gradle-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This section focuses on structuring your Gradle projects to improve clarity, mai
Use Kotlin DSL instead of the traditional Groovy DSL. You avoid learning another language and gain the benefits of strict
typing. Strict typing lets IDEs provide better support for refactoring and auto-completion, making development more efficient.

Find more information in [Gradles Kotlin DSL primer](https://docs.gradle.org/current/userguide/kotlin_dsl.html).
Find more information in [Gradle's Kotlin DSL primer](https://docs.gradle.org/current/userguide/kotlin_dsl.html).

Read Gradle's [blog](https://blog.gradle.org/kotlin-dsl-is-now-the-default-for-new-gradle-builds) about Kotlin DSL becoming
the default for Gradle builds.
Expand Down Expand Up @@ -143,4 +143,4 @@ start a new feature, you can immediately access incremental builds.

Keep in mind that a slow internet connection might make transferring cached results slower than running tasks locally.

Learn more in Gradle's documentation about their [Build cache](https://docs.gradle.org/current/userguide/build_cache.html).
Learn more in Gradle's documentation about their [Build cache](https://docs.gradle.org/current/userguide/build_cache.html).
4 changes: 2 additions & 2 deletions docs/topics/gradle/gradle-configure-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -976,8 +976,8 @@ Kotlin/Native targets do not require additional test dependencies, and the `kotl
```kotlin
kotlin {
sourceSets {
commonTest.dependencies {
implementation(kotlin("test")) // This brings all the platform dependencies automatically
commonTest.dependencies {
implementation(kotlin("test")) // This brings all the platform dependencies automatically
}
}
}
Expand Down
6 changes: 3 additions & 3 deletions docs/topics/gsoc-2023.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ In particular:
* The IDE doesn't provide any quick-fixes that fill in all the required arguments with parameters that can be forwarded.

One notable example where such support would be greatly appreciated is Jetpack Compose.
Androids modern tool kit for building UI, Jetpack Compose heavily uses function composition and parameter forwarding.
Android's modern tool kit for building UI, Jetpack Compose heavily uses function composition and parameter forwarding.
It quickly becomes tedious to work with `@Composable` functions because they have a lot of parameters.
For example, `androidx.compose.material.TextField` has 19 parameters.

Expand Down Expand Up @@ -175,7 +175,7 @@ Its documentation, integration tests, and examples are also lagging.
**Motivation**

The library has already been implemented, but it is sometimes difficult to use correctly and confuses some users.
Improving the librarys user experience would greatly help the Kotlin community.
Improving the library's user experience would greatly help the Kotlin community.

**Expected outcomes**

Expand Down Expand Up @@ -216,4 +216,4 @@ Find ways to improve the graph representation of coroutines.

* Kotlin
* Kotlin coroutines
* IntelliJ IDEA plugin development
* IntelliJ IDEA plugin development
12 changes: 6 additions & 6 deletions docs/topics/gsoc-2024.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ and [contributor guidelines](#kotlin-contributor-guidelines-for-google-summer-of
2. Familiarize yourself with the Kotlin language:
* The official [Kotlin website](https://kotlinlang.org/) is a great place to start.
* Read the official [documentation](getting-started.md) to get a better understanding of the language.
* Take a look at the Kotlin courses on [JetBrains Academy](https://lp.jetbrains.com/academy/learn-kotlin/) or the Android teams [Training options](https://developer.android.com/courses/).
* Take a look at the Kotlin courses on [JetBrains Academy](https://lp.jetbrains.com/academy/learn-kotlin/) or the Android team's [Training options](https://developer.android.com/courses/).
* Follow the [Kotlin X](https://twitter.com/kotlin) or [Kotlin Bluesky](https://bsky.app/profile/kotlinlang.org) accounts to stay up to date on the latest news and developments.
* Check out the [Kotlin YouTube channel](https://www.youtube.com/@Kotlin) for tutorials, tips, and the latest updates.

Expand Down Expand Up @@ -68,7 +68,7 @@ Artem Kobzar, JetBrains

[Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform) is a declarative framework for sharing UIs built with Kotlin across multiple platforms.
The current approach to rendering desktop applications uses the JVM as a platform,
but what if we use Compose Multiplatform for Web and try to run an application outside the browser with Skias native bindings?
but what if we use Compose Multiplatform for Web and try to run an application outside the browser with Skia's native bindings?
Will this improve desktop applications performance and memory consumption? Or will it do the opposite?
We'll find out in this project!

Expand All @@ -87,7 +87,7 @@ Artem Kobzar, JetBrains
### Compose Multiplatform component gallery generator [Medium, 350 hrs]

[Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform) is a declarative framework for sharing UIs built with Kotlin across multiple platforms.
At the beginning of the React era of web development, Storybook was created, and Storybooks proposed approach of describing component states
At the beginning of the React era of web development, Storybook was created, and Storybook's proposed approach of describing component states
and generating the whole UI library gallery is still one of the essential approaches to documentation in web development.
Can we do the same with Compose Multiplatform, using it to generate a gallery of web UI elements, as well as galleries for mobile and desktop?
Let's give it a try in this project.
Expand Down Expand Up @@ -173,7 +173,7 @@ Oleg Nenashev, Gradle

The [kotlinx-benchmark library](https://github.com/Kotlin/kotlinx-benchmark), an open-source toolkit,
facilitates the benchmarking of Kotlin code across various platforms.
It currently features GC profiling for the JVM, detailing each benchmark methods allocation rate.
It currently features GC profiling for the JVM, detailing each benchmark method's allocation rate.
This project aims to extend similar profiling capabilities to Kotlin/Native, advancing toward uniform benchmarking capabilities across platforms.

The contributor will collaborate closely with the Kotlin/Native team to create an API for accessing allocation data from the Kotlin/Native memory manager.
Expand Down Expand Up @@ -201,7 +201,7 @@ including the JVM, JS, WasmJs, and Native. Despite its broad compatibility, the
This project aims to bridge that gap. The plan is to utilize an existing Android library,
such as androidx.benchmark, behind the scenes to integrate this functionality.
A key aspect of the project will be ensuring that all features currently available for other platforms are also supported on Android,
maintaining the librarys multiplatform utility.
maintaining the library's multiplatform utility.

**Expected outcomes**

Expand All @@ -220,7 +220,7 @@ Rahul Ravikumar, Google

[kotlinx-benchmark](https://github.com/Kotlin/kotlinx-benchmark) is an open-source library for benchmarking multiplatform code written in Kotlin.
It includes a Gradle plugin that, when applied, provides tasks for running benchmarks.
However, executing these tasks requires navigating to the IDEs Gradle panel or using the terminal.
However, executing these tasks requires navigating to the IDE's Gradle panel or using the terminal.
Additionally, running a specific benchmark necessitates further steps, adding to the complication.
To mitigate this inconvenience and streamline the process, this project aims to enable users to run an individual benchmark
or an entire suite directly from the IntelliJ IDEA interface, mirroring the convenience offered for unit tests.
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/gsoc-2025.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Yahor Berdnikau, Bálint Hegyi, and Reinhold Degenfellner

* **Task #2**.
Practice assignment:
Create a Gradle plugin which exposes a specific task. This task should, in the presence of the Kotlin Gradle Plugin, retrieve all the Kotlin sources structures and output them.
Create a Gradle plugin which exposes a specific task. This task should, in the presence of the Kotlin Gradle Plugin, retrieve all the Kotlin sources' structures and output them.
Including tests would be a bonus.

### Support Android and iOS targets in Kotlin Multiplatform for Gemini using Vertex AI in Firebase [Medium, 175 hrs]
Expand Down
12 changes: 6 additions & 6 deletions docs/topics/js/js-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ It also includes a UI library called Silk, a set of versatile widgets for modern
Kobweb also supports site export, generating page snapshots
for SEO and automatic search indexing. Additionally, Kobweb makes it easy to create DOM-based UIs that efficiently update in response to state changes.

Visit the [Kobweb](https://kobweb.varabyte.com/) site for documentation and examples.
Visit the [Kobweb site](https://kobweb.varabyte.com/) for documentation and examples.

For updates and discussions about the framework, join the [#kobweb](https://kotlinlang.slack.com/archives/C04RTD72RQ8) and
[#compose-web](https://kotlinlang.slack.com/archives/C01F2HV7868) channels in the Kotlin Slack.
[#compose-web](https://kotlinlang.slack.com/archives/C01F2HV7868) channels in the [Kotlin Slack](https://surveys.jetbrains.com/s3/kotlin-slack-sign-up).

### KVision

Expand All @@ -53,7 +53,7 @@ that can be used as building blocks for your application's user interface. You c
models to build your frontend, use connectors for Ktor, Spring Boot, and other frameworks to integrate it with your server-side
applications, and share code using [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html).

[Visit KVision site](https://kvision.io) for documentation, tutorials, and examples.
Visit the [KVision site](https://kvision.io) for documentation, tutorials, and examples.

For updates and discussions about the framework, join the [#kvision](https://kotlinlang.slack.com/messages/kvision) and
[#javascript](https://kotlinlang.slack.com/archives/C0B8L3U69) channels in the [Kotlin Slack](https://surveys.jetbrains.com/s3/kotlin-slack-sign-up).
Expand All @@ -64,7 +64,7 @@ _fritz2_ is a standalone framework for building reactive web user interfaces. It
and rendering HTML elements, and it makes use of Kotlin's coroutines and flows to express components and their data bindings.
It provides state management, validation, routing, and more out of the box, and integrates with Kotlin Multiplatform projects.

[Visit fritz2 site](https://www.fritz2.dev) for documentation, tutorials, and examples.
Visit the [fritz2 site](https://www.fritz2.dev) for documentation, tutorials, and examples.

For updates and discussions about the framework, join the [#fritz2](https://kotlinlang.slack.com/messages/fritz2) and
[#javascript](https://kotlinlang.slack.com/archives/C0B8L3U69) channels in the [Kotlin Slack](https://surveys.jetbrains.com/s3/kotlin-slack-sign-up).
Expand All @@ -75,12 +75,12 @@ _Doodle_ is a vector-based UI framework for Kotlin/JS. Doodle applications use t
user interfaces instead of relying on DOM, CSS, or Javascript. By using this approach, Doodle gives you precise control
over the rendering of arbitrary UI elements, vector shapes, gradients, and custom visualizations.

[Visit Doodle site](https://nacular.github.io/doodle/) for documentation, tutorials, and examples.
Visit the [Doodle site](https://nacular.github.io/doodle/) for documentation, tutorials, and examples.

For updates and discussions about the framework, join the [#doodle](https://kotlinlang.slack.com/messages/doodle) and
[#javascript](https://kotlinlang.slack.com/archives/C0B8L3U69) channels in the [Kotlin Slack](https://surveys.jetbrains.com/s3/kotlin-slack-sign-up).

## Join the Kotlin/JS community

You can join the [#javascript](https://kotlinlang.slack.com/archives/C0B8L3U69) channel in the official [Kotlin Slack](https://surveys.jetbrains.com/s3/kotlin-slack-sign-up)
to chat with the community and the team.
to chat with the community and the team.
42 changes: 21 additions & 21 deletions docs/topics/kotlin-language-features-and-proposals.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ guided by pragmatic design.

**kotlin.time.Instant**

* KEEP proposal: [Instant and Clock](https://github.com/dkhalanskyjb/KEEP/blob/dkhalanskyjb-instant/proposals/stdlib/instant.md)
* KEEP proposal: [Instant and Clock](https://github.com/Kotlin/KEEP/blob/master/proposals/stdlib/instant.md)

</td>
</tr>
Expand All @@ -146,7 +146,7 @@ guided by pragmatic design.

**Common Atomics and Atomic Arrays**

* KEEP proposal: [Common atomics](https://github.com/Kotlin/KEEP/blob/mvicsokolova/common-atomics/proposals/common-atomics.md)
* KEEP proposal: [Common atomics](https://github.com/Kotlin/KEEP/blob/master/proposals/stdlib/common-atomics.md)
* YouTrack issue: [KT-62423](https://youtrack.jetbrains.com/issue/KT-62423)

</td>
Expand All @@ -162,7 +162,7 @@ guided by pragmatic design.

**Improvements to annotation use-site targets on properties**

* KEEP proposal: [Improvements to annotation use-site targets on properties](https://github.com/Kotlin/KEEP/blob/change-defaulting-rule/proposals/change-defaulting-rule.md)
* KEEP proposal: [Improvements to annotation use-site targets on properties](https://github.com/Kotlin/KEEP/blob/master/proposals/annotation-target-in-properties.md)
* YouTrack issue: [KT-19289](https://youtrack.jetbrains.com/issue/KT-19289)

</td>
Expand All @@ -178,7 +178,7 @@ guided by pragmatic design.

**Nested (non-capturing) type aliases**

* KEEP proposal: [Nested (non-capturing) type aliases](https://github.com/Kotlin/KEEP/blob/nested-typealias/proposals/nested-typealias.md)
* KEEP proposal: [Nested (non-capturing) type aliases](https://github.com/Kotlin/KEEP/blob/master/proposals/nested-typealias.md)
* YouTrack issue: [KT-45285](https://youtrack.jetbrains.com/issue/KT-45285)

</td>
Expand Down Expand Up @@ -336,23 +336,6 @@ guided by pragmatic design.

<!-- the first td element should have the width="200" attribute -->

<tr filter="stable">
<td>

**Stable**

</td>
<td>

**Stabilized `@SubclassOptInRequired`**

* KEEP proposal: [subclass-opt-in-required.md](https://github.com/Kotlin/KEEP/blob/master/proposals/subclass-opt-in-required.md)
* YouTrack issue: [KT-54617](https://youtrack.jetbrains.com/issue/KT-54617)
* Available since: 2.1.0

</td>
</tr>

<tr filter="in-preview">
<td>

Expand Down Expand Up @@ -416,6 +399,23 @@ guided by pragmatic design.
</td>
<td>

**Stabilized `@SubclassOptInRequired`**

* KEEP proposal: [subclass-opt-in-required.md](https://github.com/Kotlin/KEEP/blob/master/proposals/subclass-opt-in-required.md)
* YouTrack issue: [KT-54617](https://youtrack.jetbrains.com/issue/KT-54617)
* Available since: 2.1.0

</td>
</tr>

<tr filter="stable">
<td>

**Stable**

</td>
<td>

Comment on lines +402 to +418
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JFYI
I moved this one from IN PREVIEW BLOCK to STABLE BLOCK

**Data objects**

* KEEP proposal: [data-objects.md](https://github.com/Kotlin/KEEP/blob/master/proposals/data-objects.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/kotlin-pdf.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

Here you can download a PDF version of Kotlin documentation that includes everything except tutorials and API reference.

**[Download Kotlin 2.1.20 documentation (PDF)](https://kotlinlang.org/docs/kotlin-reference.pdf)**
**[Download Kotlin %kotlinVersion% documentation (PDF)](https://kotlinlang.org/docs/kotlin-reference.pdf)**

**[View the latest Kotlin documentation (online)](home.topic)**
**[View the latest Kotlin documentation (online)](home.topic)**
2 changes: 1 addition & 1 deletion docs/topics/metadata-jvm.md
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,7 @@ fun main() {
visitEnd()
}.toByteArray()

// Writes the generated class file to disk
// Writes the generated .class file to disk
java.io.File("Hello.class").writeBytes(classBytes)

println("Metadata and .class file created successfully.")
Expand Down
6 changes: 3 additions & 3 deletions docs/topics/native/mapping-function-pointers-from-c.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<p>This is the third part of the <strong>Mapping Kotlin and C</strong> tutorial series. Before proceeding, make sure you've completed the previous steps.</p>
<p><img src="icon-1-done.svg" width="20" alt="First step"/> <a href="mapping-primitive-data-types-from-c.md">Mapping primitive data types from C</a><br/>
<img src="icon-2-done.svg" width="20" alt="Second step"/> <a href="mapping-struct-union-types-from-c.md">Mapping struct and union types from C</a><br/>
<img src="icon-3.svg" width="20" alt="Third step"/> <strong>Mapping function pointers</strong><br/>
<img src="icon-3.svg" width="20" alt="Third step"/> <strong>Mapping function pointers from C</strong><br/>
<img src="icon-4-todo.svg" width="20" alt="Fourth step"/> <a href="mapping-strings-from-c.md">Mapping strings from C</a><br/>
</p>
</tldr>
Expand All @@ -30,7 +30,7 @@ In this tutorial, you'll:
To understand the mapping between Kotlin and C, let's declare two functions: one that accepts a function pointer as a
parameter and another that returns a function pointer.

In the [first part of the series](mapping-primitive-data-types-from-c.md) of the series, you've already created a C library with the
In the [first part of the series](mapping-primitive-data-types-from-c.md), you've already created a C library with the
necessary files. For this step, update the declarations in the `interop.def` file after the `---` separator:

```c
Expand Down Expand Up @@ -174,4 +174,4 @@ In the next part of the series, you'll learn how strings are mapped between Kotl

### See also

Learn more in the [Interoperability with C](native-c-interop.md) documentation that covers more advanced scenarios.
Learn more in the [Interoperability with C](native-c-interop.md) documentation that covers more advanced scenarios.
4 changes: 2 additions & 2 deletions docs/topics/native/mapping-primitive-data-types-from-c.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<p>This is the first part of the <strong>Mapping Kotlin and C</strong> tutorial series.</p>
<p><img src="icon-1.svg" width="20" alt="First step"/> <strong>Mapping primitive data types from C</strong><br/>
<img src="icon-2-todo.svg" width="20" alt="Second step"/> <a href="mapping-struct-union-types-from-c.md">Mapping struct and union types from C</a><br/>
<img src="icon-3-todo.svg" width="20" alt="Third step"/> <a href="mapping-function-pointers-from-c.md">Mapping function pointers</a><br/>
<img src="icon-3-todo.svg" width="20" alt="Third step"/> <a href="mapping-function-pointers-from-c.md">Mapping function pointers from C</a><br/>
<img src="icon-4-todo.svg" width="20" alt="Fourth step"/> <a href="mapping-strings-from-c.md">Mapping strings from C</a><br/>
</p>
</tldr>
Expand Down Expand Up @@ -279,4 +279,4 @@ In the next part of the series, you'll learn how struct and union types are mapp

### See also

Learn more in the [Interoperability with C](native-c-interop.md) documentation that covers more advanced scenarios.
Learn more in the [Interoperability with C](native-c-interop.md) documentation that covers more advanced scenarios.
Loading