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

Fix incorrect generateEditorConfig example in documentation #2444

Merged
merged 1 commit into from
Dec 19, 2023

Conversation

stay7
Copy link
Contributor

@stay7 stay7 commented Dec 19, 2023

Description

I found incorrect example in the documentation for the ktlint generateEditorConfig command.
The code-style parameter defaults to ktlint_official, but there is no default value for the code-style parameter.

$ ktlint --version
1.1.0

$ ktlint generateEditorConfig
Exception in thread "main" picocli.CommandLine$MissingParameterException: Missing required parameter: 'code-style'

internal class GenerateEditorConfigSubCommand : Runnable {
// No default value is set as users should explicitly choose one of the code styles. In this way, it is more clear that the generated
// content is determined by the chosen value. If a default (ktlint_official) is set, and the user has not specified the code style, the
// user might not be aware that the value of the other properties are dependent on the code style.
@CommandLine.Parameters(
arity = "1",
paramLabel = "code-style",
description = [

Checklist

Before submitting the PR, please check following (checks which are not relevant may be ignored):

  • Commit message are well written. In addition to a short title, the commit message also explain why a change is made.
  • At least one commit message contains a reference Closes #<xxx> or Fixes #<xxx> (replace<xxx> with issue number)
  • Tests are added
  • KtLint format has been applied on source code itself and violations are fixed
  • PR title is short and clear (it is used as description in the release changelog)
  • PR description added (background information)

Documentation is updated. See difference between snapshot and release documentation

  • Snapshot documentation in case documentation is to be released together with a code change
  • Release documentation in case documentation is related to a released version of ktlint and has to be published as soon as the change is merged to master

@paul-dingemans paul-dingemans modified the milestone: 1.1.1 Dec 19, 2023
@paul-dingemans paul-dingemans merged commit 19a547d into pinterest:master Dec 19, 2023
11 checks passed
@paul-dingemans
Copy link
Collaborator

Tnx for reporting and including the comment about not having default value. I forgot about that ;-)
It is fixed now.

@paul-dingemans paul-dingemans added this to the 1.1.1 milestone Jan 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants