Skip to content

Fixed typos in kotlin-plugins.md, & a link in CONTRIBUTING #23

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 31, 2024
Merged

Fixed typos in kotlin-plugins.md, & a link in CONTRIBUTING #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d967c03
Fixed typos in kotlin-plugins.md, & a link in CONTRIBUTING
anurag-verma-india Oct 31, 2024
370747c
Merge branch 'main' into fixing-broken-links-and-typos
oleg-nenashev Oct 31, 2024
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
2 changes: 1 addition & 1 deletion docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Copy link
Member

Choose a reason for hiding this comment

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

Yes, better this way for rendering

When adding new pages, please update the ToC to ensure they are discoverable.

### Adding New Categories
Expand Down
6 changes: 3 additions & 3 deletions docs/plugin-development/kotlin-plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -144,7 +144,7 @@ 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.`.
Expand All @@ -156,6 +156,6 @@ The `kotlin-dls` plugin:
* `-Xjvm-default=all` to add [Default methods in interfaces](https://kotlinlang.org/docs/java-to-kotlin-interop.html#default-methods-in-interfaces)
* `-Xjsr305=strict` for [increased null safety](https://kotlinlang.org/docs/java-interop.html#compiler-configuration)

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.
Loading