From ad5a1a81383aeb02b7983fcd554846b4c92b3379 Mon Sep 17 00:00:00 2001 From: Max Eisner <4730112+max-ae@users.noreply.github.com> Date: Mon, 11 Jul 2022 15:35:48 +0200 Subject: [PATCH] add docs --- Library/Homebrew/formula.rb | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Library/Homebrew/formula.rb b/Library/Homebrew/formula.rb index 5817143e67..6353483f21 100644 --- a/Library/Homebrew/formula.rb +++ b/Library/Homebrew/formula.rb @@ -1625,6 +1625,15 @@ class Formula end private :extract_macho_slice_from + # Generate shell completions for a formula for bash, zsh, and fish, using the formula's binary. + # + # @param base_name [String] the base name of the generated completion script. Defaults to the formula name. + # @param shells [Array] 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 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`. sig { params(base_name: String, shells: T::Array[Symbol], binary: Pathname, cmd: String, shell_as_flag: T::Boolean).void }