From 319a2881985fa62c1b67f0f64dcec55ddaa1b62a Mon Sep 17 00:00:00 2001
From: Markus Reiter <me@reitermark.us>
Date: Sun, 9 Aug 2020 03:00:13 +0200
Subject: [PATCH] Document `User`.

---
 Library/Homebrew/utils/user.rb | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Library/Homebrew/utils/user.rb b/Library/Homebrew/utils/user.rb
index ce3e8e6b2e..0d5b94fb34 100644
--- a/Library/Homebrew/utils/user.rb
+++ b/Library/Homebrew/utils/user.rb
@@ -5,7 +5,11 @@ require "etc"
 
 require "system_command"
 
+# A system user.
+#
+# @api private
 class User < DelegateClass(String)
+  # Return whether the user has an active GUI session.
   def gui?
     out, _, status = system_command "who"
     return false unless status.success?
@@ -15,6 +19,7 @@ class User < DelegateClass(String)
        .any? { |user, type,| user == self && type == "console" }
   end
 
+  # Return the current user.
   def self.current
     return @current if defined?(@current)