Skip to content

Commit 3209cf2

Browse files
authored
minor fix for typo, indent, link, and sample code, etc (#4905)
* minor fix for typo, indent, link, and sample code, etc * fix for review comment
1 parent 6f04d84 commit 3209cf2

31 files changed

+101
-101
lines changed

docs/topics/basic-syntax.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ See [Functions](functions.md).
157157

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

160-
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
160+
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
161161
after initialization:
162162

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

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

docs/topics/gradle/gradle-best-practices.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This section focuses on structuring your Gradle projects to improve clarity, mai
1515
Use Kotlin DSL instead of the traditional Groovy DSL. You avoid learning another language and gain the benefits of strict
1616
typing. Strict typing lets IDEs provide better support for refactoring and auto-completion, making development more efficient.
1717

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

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

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

146-
Learn more in Gradle's documentation about their [Build cache](https://docs.gradle.org/current/userguide/build_cache.html).
146+
Learn more in Gradle's documentation about their [Build cache](https://docs.gradle.org/current/userguide/build_cache.html).

docs/topics/gradle/gradle-configure-project.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -977,8 +977,8 @@ Kotlin/Native targets do not require additional test dependencies, and the `kotl
977977
```kotlin
978978
kotlin {
979979
sourceSets {
980-
commonTest.dependencies {
981-
implementation(kotlin("test")) // This brings all the platform dependencies automatically
980+
commonTest.dependencies {
981+
implementation(kotlin("test")) // This brings all the platform dependencies automatically
982982
}
983983
}
984984
}

docs/topics/gsoc-2023.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ In particular:
143143
* The IDE doesn't provide any quick-fixes that fill in all the required arguments with parameters that can be forwarded.
144144

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

@@ -175,7 +175,7 @@ Its documentation, integration tests, and examples are also lagging.
175175
**Motivation**
176176

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

180180
**Expected outcomes**
181181

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

217217
* Kotlin
218218
* Kotlin coroutines
219-
* IntelliJ IDEA plugin development
219+
* IntelliJ IDEA plugin development

docs/topics/gsoc-2024.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ and [contributor guidelines](#kotlin-contributor-guidelines-for-google-summer-of
2020
2. Familiarize yourself with the Kotlin language:
2121
* The official [Kotlin website](https://kotlinlang.org/) is a great place to start.
2222
* Read the official [documentation](getting-started.md) to get a better understanding of the language.
23-
* 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/).
23+
* 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/).
2424
* 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.
2525
* Check out the [Kotlin YouTube channel](https://www.youtube.com/@Kotlin) for tutorials, tips, and the latest updates.
2626

@@ -68,7 +68,7 @@ Artem Kobzar, JetBrains
6868

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

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

8989
[Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform) is a declarative framework for sharing UIs built with Kotlin across multiple platforms.
90-
At the beginning of the React era of web development, Storybook was created, and Storybooks proposed approach of describing component states
90+
At the beginning of the React era of web development, Storybook was created, and Storybook's proposed approach of describing component states
9191
and generating the whole UI library gallery is still one of the essential approaches to documentation in web development.
9292
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?
9393
Let's give it a try in this project.
@@ -173,7 +173,7 @@ Oleg Nenashev, Gradle
173173

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

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

206206
**Expected outcomes**
207207

@@ -220,7 +220,7 @@ Rahul Ravikumar, Google
220220

221221
[kotlinx-benchmark](https://github.com/Kotlin/kotlinx-benchmark) is an open-source library for benchmarking multiplatform code written in Kotlin.
222222
It includes a Gradle plugin that, when applied, provides tasks for running benchmarks.
223-
However, executing these tasks requires navigating to the IDEs Gradle panel or using the terminal.
223+
However, executing these tasks requires navigating to the IDE's Gradle panel or using the terminal.
224224
Additionally, running a specific benchmark necessitates further steps, adding to the complication.
225225
To mitigate this inconvenience and streamline the process, this project aims to enable users to run an individual benchmark
226226
or an entire suite directly from the IntelliJ IDEA interface, mirroring the convenience offered for unit tests.

docs/topics/gsoc-2025.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Yahor Berdnikau, Bálint Hegyi, and Reinhold Degenfellner
7676

7777
* **Task #2**.
7878
Practice assignment:
79-
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.
79+
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.
8080
Including tests would be a bonus.
8181

8282
### Support Android and iOS targets in Kotlin Multiplatform for Gemini using Vertex AI in Firebase [Medium, 175 hrs]

docs/topics/js/js-overview.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ It also includes a UI library called Silk, a set of versatile widgets for modern
4141
Kobweb also supports site export, generating page snapshots
4242
for SEO and automatic search indexing. Additionally, Kobweb makes it easy to create DOM-based UIs that efficiently update in response to state changes.
4343

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

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

4949
### KVision
5050

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

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

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

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

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

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

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

8383
## Join the Kotlin/JS community
8484

8585
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)
86-
to chat with the community and the team.
86+
to chat with the community and the team.

docs/topics/kotlin-language-features-and-proposals.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ guided by pragmatic design.
221221
**Improvements to annotation use-site targets on properties**
222222

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

@@ -239,7 +239,7 @@ guided by pragmatic design.
239239
**Nested (non-capturing) type aliases**
240240

241241
* KEEP
242-
proposal: [Nested (non-capturing) type aliases](https://github.com/Kotlin/KEEP/blob/nested-typealias/proposals/nested-typealias.md)
242+
proposal: [Nested (non-capturing) type aliases](https://github.com/Kotlin/KEEP/blob/master/proposals/nested-typealias.md)
243243
* YouTrack issue: [KT-45285](https://youtrack.jetbrains.com/issue/KT-45285)
244244
* Available since: 2.2.0
245245

docs/topics/metadata-jvm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -475,7 +475,7 @@ fun main() {
475475
visitEnd()
476476
}.toByteArray()
477477

478-
// Writes the generated class file to disk
478+
// Writes the generated .class file to disk
479479
java.io.File("Hello.class").writeBytes(classBytes)
480480

481481
println("Metadata and .class file created successfully.")

docs/topics/native/mapping-function-pointers-from-c.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<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>
55
<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/>
66
<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/>
7-
<img src="icon-3.svg" width="20" alt="Third step"/> <strong>Mapping function pointers</strong><br/>
7+
<img src="icon-3.svg" width="20" alt="Third step"/> <strong>Mapping function pointers from C</strong><br/>
88
<img src="icon-4-todo.svg" width="20" alt="Fourth step"/> <a href="mapping-strings-from-c.md">Mapping strings from C</a><br/>
99
</p>
1010
</tldr>
@@ -30,7 +30,7 @@ In this tutorial, you'll:
3030
To understand the mapping between Kotlin and C, let's declare two functions: one that accepts a function pointer as a
3131
parameter and another that returns a function pointer.
3232

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

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

175175
### See also
176176

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

0 commit comments

Comments
 (0)