From 23cbb79810c00c024a812f65b16567d5b4280232 Mon Sep 17 00:00:00 2001
From: Markus Reiter <me@reitermark.us>
Date: Fri, 14 Aug 2020 03:45:47 +0200
Subject: [PATCH] Document `Debrew`.

---
 Library/Homebrew/debrew.rb | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Library/Homebrew/debrew.rb b/Library/Homebrew/debrew.rb
index 33209cffe1..6382cbca0c 100644
--- a/Library/Homebrew/debrew.rb
+++ b/Library/Homebrew/debrew.rb
@@ -3,11 +3,15 @@
 require "mutex_m"
 require "debrew/irb"
 
+# Helper module for debugging formulae.
+#
+# @api private
 module Debrew
   extend Mutex_m
 
   Ignorable = Module.new.freeze
 
+  # Module for allowing to ignore exceptions.
   module Raise
     def raise(*)
       super
@@ -19,6 +23,7 @@ module Debrew
     alias fail raise
   end
 
+  # Module for allowing to debug formulae.
   module Formula
     def install
       Debrew.debrew { super }
@@ -33,6 +38,7 @@ module Debrew
     end
   end
 
+  # Module for displaying a debugging menu.
   class Menu
     Entry = Struct.new(:name, :action)