admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

update arg names in docs and signature

Browse Source
This commit is contained in:
Max Eisner 2022-07-31 21:01:42 +02:00
parent dff3fc9d2f
commit b2d94dc897
No known key found for this signature in database
GPG Key ID: 4BF122C22879F0C8
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Library/Homebrew/formula.rb
View File

@ -1625,18 +1625,19 @@ class Formula
end
private :extract_macho_slice_from
# Generate shell completions for a formula for bash, zsh, and fish, using the formula's binary.
# Generate shell completions for a formula for bash, zsh, and fish, using the formula's executable.
#
# @param base_name [String] the base name of the generated completion script. Defaults to the formula name.
# @param shells [Array<Symbol>] the shells to generate completion scripts for. Defaults to `[:bash, :zsh, :fish]`.
# @param binary [Pathname] the binary to use for generating the completion scripts. Defaults to the binary with the
# name of the formula.
# @param executable [Pathname] the executable to use for generating the completion scripts. Defaults to the
# executable with the name of the formula.
# @param cmd [String] the command to pass to the `binary`. Defaults to 'completion'.
# @param shell_as_flag [Boolean] specify if `shells` should each be passed as flags to the `binary`.
# Defaults to `false`.
# @param shell_parameter_format [String]/[Symbol] specify how `shells` should each be passed
# to the `executable`. Takes either a String representing a prefix, or one of [:flag, :arg, :none].
# Defaults to plainly passing the shell.
sig {
params(base_name: String, shells: T::Array[Symbol], binary: Pathname, cmd: String,
shell_prefix: T.nilable(T.any(Symbol, String))).void
params(base_name: String, shells: T::Array[Symbol], executable: Pathname, cmd: String,
shell_parameter_format: T.nilable(T.any(Symbol, String))).void
}
def generate_completions_from_executable(base_name: name,
shells: [:bash, :zsh, :fish],