From d967c03d732a3d1ebf46d400996cdaa351984005 Mon Sep 17 00:00:00 2001 From: Anurag Verma <104461155+anurag-verma-india@users.noreply.github.com> Date: Fri, 1 Nov 2024 01:22:16 +0530 Subject: [PATCH] Fixed typos in kotlin-plugins.md, & a link in CONTRIBUTING Fixed some typos ./docs/plugin-development/kotlin-plugins.md, and a link to mkdocs.yml in CONTRIBUTING.md --- docs/CONTRIBUTING.md | 2 +- docs/plugin-development/kotlin-plugins.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 5a3e862..501efcb 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -23,7 +23,7 @@ A few tips: - All the pages on this site are written in Markdown. - If needed, we have various tools available, such as code templates and macros, and we can add more MkDocs plugins if necessary. -- The Table of Contents is currently located in [mkdocs.yml](../mkdocs.yml). +- The Table of Contents is currently located in [mkdocs.yml](https://github.com/gradle/cookbook/blob/main/mkdocs.yml). When adding new pages, please update the ToC to ensure they are discoverable. ### Adding New Categories diff --git a/docs/plugin-development/kotlin-plugins.md b/docs/plugin-development/kotlin-plugins.md index 3a1a0c3..3b7352c 100644 --- a/docs/plugin-development/kotlin-plugins.md +++ b/docs/plugin-development/kotlin-plugins.md @@ -106,7 +106,7 @@ In general Groovy does not know anything about Kotlin. Avoid Kotlin-only feature - receivers - etc... -These features may be used in extra functionality for Kotlin callers but it is important that all the base functionality of your plugin does not require them. +These features may be used in extra functionality for Kotlin callers, but it is important that all the base functionality of your plugin does not require them. ### Closures @@ -143,18 +143,18 @@ If you are used to writing `build.gradle.kts` files, you may use the `kotlin-dsl The `kotlin-dls` plugin: * applies `"java-gradle-plugin"`. -* applies `kotlin-embedded` to use the same Kotlin embeeded version as your Gradle distribution. +* applies `kotlin-embedded` to use the same Kotlin embedded version as your Gradle distribution. * applies the ``kotlin-dsl-precompiled-script-plugins`` allowing to use `build.gradle.kts` files. * adds `gradleKotlinDsl()` to the `compileOnly` configuration. * configures the `sam-with-receiver` Kotlin compiler plugin to transform `it.` usages into `this.`. * configures the `kotlin-assignment` Kotlin compiler plugin to allow setting `Property` with the `=` operator. -* sets Kotlin `apiVersion` and `languageVersion` according to Gradle [compatibility [atrix](https://docs.gradle.org/current/userguide/compatibility.html#kotlin). +* sets Kotlin `apiVersion` and `languageVersion` according to Gradle [compatibility matrix](https://docs.gradle.org/current/userguide/compatibility.html#kotlin). * adds the `-Xsam-conversions=class` compiler option. * adds others compiler options for compatibility: ** `-java-parameters` to support https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Parameter.html[Java 8 Parameter] class and getting method parameters through reflection ** `-Xjvm-default=all` to add link:https://kotlinlang.org/docs/java-to-kotlin-interop.html#default-methods-in-interfaces[Default methods in interfaces] ** `-Xjsr305=strict` for https://kotlinlang.org/docs/java-interop.html#compiler-configuration[increased null safety] -This is a significant departure from the baseline Kotlin configuration so be aware of the tradeoffs when using `kotlin-dsl`. +This is a significant departure from the baseline Kotlin configuration so be aware of the trade-offs when using `kotlin-dsl`. Also, `kotlin-dsl` targets the Kotlin embedded version of your current distribution. If you want to be compatible with lower versions of Gradle, using the `com.jetbrains.kotlin.jvm` plugin provides more flexibility. \ No newline at end of file