From 70cfb52158fbfa0769b4c41a3efbfb09f61d89ef Mon Sep 17 00:00:00 2001
From: Markus Reiter <me@reitermark.us>
Date: Wed, 19 Aug 2020 07:02:01 +0200
Subject: [PATCH] Document `Sandbox`.

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

diff --git a/Library/Homebrew/sandbox.rb b/Library/Homebrew/sandbox.rb
index d50ec020f1..a0ab6c2141 100644
--- a/Library/Homebrew/sandbox.rb
+++ b/Library/Homebrew/sandbox.rb
@@ -3,8 +3,12 @@
 require "erb"
 require "tempfile"
 
+# Helper class for running a sub-process inside of a sandboxed environment.
+#
+# @api private
 class Sandbox
   SANDBOX_EXEC = "/usr/bin/sandbox-exec"
+  private_constant :SANDBOX_EXEC
 
   def self.available?
     OS.mac? && File.executable?(SANDBOX_EXEC)
@@ -139,6 +143,7 @@ class Sandbox
     end
   end
 
+  # Configuration profile for a sandbox.
   class SandboxProfile
     SEATBELT_ERB = <<~ERB
       (version 1)
@@ -181,4 +186,5 @@ class Sandbox
       ERB.new(SEATBELT_ERB).result(binding)
     end
   end
+  private_constant :SandboxProfile
 end