Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
juraj-hrivnak authored Jan 31, 2025
1 parent 001734b commit 19e5d95
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,9 @@ Command parameters should be _suffixed_ with a special abbreviation of the param
Use: `Opt` for options, `Arg` for arguments, and `Flag` for flags (Boolean options).
If there can be multiple parameters use the plural, e.g. `Opts`, `Args`.

Defining parameters using a chain of function calls is preferred.

```kt
// Parameters should be always private.
// Defining parameters using a chain of function calls is preferred.

private val exampleOpt by option("--example") // Consult if a short version `-e` of the option is a good idea
.help("...") // Consider discussing the help message
Expand Down

0 comments on commit 19e5d95

Please sign in to comment.