Skip to content
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

Remove double negation in configuration option names #2515

Open
mahozad opened this issue May 31, 2022 · 0 comments
Open

Remove double negation in configuration option names #2515

mahozad opened this issue May 31, 2022 · 0 comments
Labels
configuration An issue/PR related to Dokka's configuration by the user enhancement An issue for a feature or an overall improvement runner: gradle plugin v2 Issues fixed by Dokka Gradle Plugin v2 - see https://github.com/Kotlin/dokka/issues/3131 runner: Gradle plugin An issue/PR related to Dokka's Gradle plugin tech-debt A technical issue that is not observable by the users, but improves maintainers quality of life
Milestone

Comments

@mahozad
Copy link
Contributor

mahozad commented May 31, 2022

Created this issue as discussed in #2513.

It would be great if the methods in Dokka Gradle plugin were converted to properties and also avoided double negative names.

So, for instance, noAndroidSdkLink.set(false) can be renamed to something like useAndroidSdkLink = true or isAndroidSdkLinkEnabled = true or enableAndroidSdkLink = true or similar.

As an example, here is some of Android Gradle Plugin (AGP) properties which were renamed in its recent versions:

android {
  buildTypes {
    release {
      isTestCoverageEnabled = true
      isMinifyEnabled = false
    }
  }
}

Are you willing to provide a PR?
Maybe (depends on if the maintainers want it and if I can).

@mahozad mahozad added the enhancement An issue for a feature or an overall improvement label May 31, 2022
@IgnatBeresnev IgnatBeresnev changed the title Improve Gradle plugin interface Remove double negation in configuration option names Dec 14, 2022
@IgnatBeresnev IgnatBeresnev added the configuration An issue/PR related to Dokka's configuration by the user label Mar 8, 2023
@IgnatBeresnev IgnatBeresnev added the tech-debt A technical issue that is not observable by the users, but improves maintainers quality of life label Apr 21, 2023
@IgnatBeresnev IgnatBeresnev added this to the Gradle runner 2.0 milestone Aug 17, 2023
@adam-enko adam-enko added runner: Gradle plugin An issue/PR related to Dokka's Gradle plugin runner: gradle plugin v2 Issues fixed by Dokka Gradle Plugin v2 - see https://github.com/Kotlin/dokka/issues/3131 labels Sep 25, 2024
adam-enko added a commit that referenced this issue Sep 26, 2024
adam-enko added a commit that referenced this issue Sep 26, 2024
adam-enko added a commit that referenced this issue Sep 26, 2024
* DGPv2: fix noJdkLink/noStdlibLink/noAndroidSdkLink

#2515
KT-71758

* remove test

* update ABI dump

* suppress 'unused' on deprecated properties
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
configuration An issue/PR related to Dokka's configuration by the user enhancement An issue for a feature or an overall improvement runner: gradle plugin v2 Issues fixed by Dokka Gradle Plugin v2 - see https://github.com/Kotlin/dokka/issues/3131 runner: Gradle plugin An issue/PR related to Dokka's Gradle plugin tech-debt A technical issue that is not observable by the users, but improves maintainers quality of life
Projects
None yet
Development

No branches or pull requests

3 participants