From cc624bc6a4a5bb8aead03ff7a6a7c9354a8d810d Mon Sep 17 00:00:00 2001
From: Yegor Bugayenko <yegor256@gmail.com>
Date: Sat, 10 Aug 2024 08:41:48 +0300
Subject: [PATCH] #59 doc

---
 lib/fbe/octo.rb | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/lib/fbe/octo.rb b/lib/fbe/octo.rb
index cc78f03..b2b9545 100644
--- a/lib/fbe/octo.rb
+++ b/lib/fbe/octo.rb
@@ -33,6 +33,15 @@
 require_relative 'middleware'
 require_relative 'middleware/quota'
 
+# Interface to GitHub API.
+#
+# It is supposed to be used instead of Octokit client, because it
+# is pre-configured and enables additional fearues, such as retrying,
+# logging, and caching.
+#
+# @param [Judges::Options] options The options available globally
+# @param [Hash] global Hash of global options
+# @param [Loog] loog Logging facility
 def Fbe.octo(options: $options, global: $global, loog: $loog)
   raise 'The $global is not set' if global.nil?
   global[:octo] ||=