From 6a364c9e1fca507689f8f58eb50716d0eeff717d Mon Sep 17 00:00:00 2001
From: Markus Reiter <me@reitermark.us>
Date: Mon, 17 Aug 2020 18:45:48 +0200
Subject: [PATCH] Document `Keg`.

---
 Library/Homebrew/keg.rb | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/Library/Homebrew/keg.rb b/Library/Homebrew/keg.rb
index 4698dcfa0c..00668f1250 100644
--- a/Library/Homebrew/keg.rb
+++ b/Library/Homebrew/keg.rb
@@ -6,9 +6,13 @@ require "lock_file"
 require "ostruct"
 require "extend/cachable"
 
+# Installation prefix of a formula.
+#
+# @api private
 class Keg
   extend Cachable
 
+  # Error for when a keg is already linked.
   class AlreadyLinkedError < RuntimeError
     def initialize(keg)
       super <<~EOS
@@ -18,6 +22,7 @@ class Keg
     end
   end
 
+  # Error for when a keg cannot be linked.
   class LinkError < RuntimeError
     attr_reader :keg, :src, :dst
 
@@ -31,6 +36,7 @@ class Keg
     end
   end
 
+  # Error for when a file already exists or belongs to another keg.
   class ConflictError < LinkError
     def suggestion
       conflict = Keg.for(dst)
@@ -58,6 +64,7 @@ class Keg
     end
   end
 
+  # Error for when a directory is not writable.
   class DirectoryNotWritableError < LinkError
     def to_s
       <<~EOS