clikt icon indicating copy to clipboard operation
clikt copied to clipboard

Add imports to example Clikt program

Open m0xb opened this issue 1 year ago • 1 comments

The example program in the readme and quickstart doc page (https://github.com/ajalt/clikt/blob/master/README.md and https://ajalt.github.io/clikt/quickstart/) don't include imports. Trying to compile fails with "Unresolved reference: CliktCommand".

Screenshot 2024-06-27 at 10 10 49 PM

It looks like the following imports are needed:

import com.github.ajalt.clikt.core.CliktCommand
import com.github.ajalt.clikt.parameters.options.default
import com.github.ajalt.clikt.parameters.options.help
import com.github.ajalt.clikt.parameters.options.option
import com.github.ajalt.clikt.parameters.types.int
import com.github.ajalt.clikt.parameters.options.prompt

I see an old issue mentioning the same thing, but it's closed now: https://github.com/ajalt/clikt/issues/335

m0xb avatar Jun 28 '24 05:06 m0xb

Usually, the docs for Java or Kotlin libraries do not include the required imports to be more readable. You can auto import the required classes or functions within the IDE.

It seems this example is not a module or sample in the samples module. If there is an issue that causes build failure, the CI would have caught it.

EchoEllet avatar Jul 07 '24 13:07 EchoEllet

I agree with EchoEllet. To save space in the docs, I'll leave out the imports

ajalt avatar Sep 15 '24 23:09 ajalt