fix: fix Rubocop Style/Documentation offense

jcouball · jcouball · commit e80c27dbb50b · 2025-07-03T16:10:33.000-07:00
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -3,12 +3,18 @@ inherit_from: .rubocop_todo.yml
 inherit_gem:
   main_branch_shared_rubocop_config: config/rubocop.yml
 
+# Testing and gemspec DSL results in large blocks
 Metrics/BlockLength:
   Exclude:
     - "tests/test_helper.rb"
     - "tests/units/**/*"
     - "*.gemspec"
 
+# Don't force every test class to be described
+Style/Documentation:
+  Exclude:
+    - "tests/units/**/*"
+
 AllCops:
   # Pin this project to Ruby 3.1 in case the shared config above is upgraded to 3.2
   # or later.
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -6,11 +6,6 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 66
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Enabled: false
-
 # Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
 Style/IfUnlessModifier:
diff --git a/lib/git/author.rb b/lib/git/author.rb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Git
+  # An author in a Git commit
   class Author
     attr_accessor :name, :email, :date
 
diff --git a/lib/git/branch.rb b/lib/git/branch.rb
@@ -3,6 +3,7 @@
 require 'git/path'
 
 module Git
+  # Represents a Git branch
   class Branch
     attr_accessor :full, :remote, :name
 
diff --git a/lib/git/config.rb b/lib/git/config.rb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Git
+  # The global configuration for this gem
   class Config
     attr_writer :binary_path, :git_ssh, :timeout
 
diff --git a/lib/git/diff.rb b/lib/git/diff.rb
@@ -76,6 +76,7 @@ def stats
       }
     end
 
+    # The changes for a single file within a diff
     class DiffFile
       attr_accessor :patch, :path, :mode, :src, :dst, :type
 
diff --git a/lib/git/diff_path_status.rb b/lib/git/diff_path_status.rb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Git
+  # The files and their status (e.g., added, modified, deleted) between two commits
   class DiffPathStatus
     include Enumerable
 
diff --git a/lib/git/lib.rb b/lib/git/lib.rb
@@ -11,6 +11,8 @@
 require 'open3'
 
 module Git
+  # Internal git operations
+  # @api private
   class Lib
     # The path to the Git working copy.  The default is '"./.git"'.
     #
diff --git a/lib/git/object.rb b/lib/git/object.rb
@@ -8,6 +8,7 @@
 module Git
   # represents a git object
   class Object
+    # A base class for all Git objects
     class AbstractObject
       attr_accessor :objectish, :type, :mode
 
@@ -79,6 +80,7 @@ def commit? = false
       def tag? = false
     end
 
+    # A Git blob object
     class Blob < AbstractObject
       def initialize(base, sha, mode = nil)
         super(base, sha)
@@ -90,6 +92,7 @@ def blob?
       end
     end
 
+    # A Git tree object
     class Tree < AbstractObject
       def initialize(base, sha, mode = nil)
         super(base, sha)
@@ -149,6 +152,7 @@ def check_tree
       end
     end
 
+    # A Git commit object
     class Commit < AbstractObject
       def initialize(base, sha, init = nil)
         super(base, sha)
@@ -240,6 +244,13 @@ def check_commit
       end
     end
 
+    # A Git tag object
+    #
+    # This class represents a tag in Git, which can be either annotated or lightweight.
+    #
+    # Annotated tags contain additional metadata such as the tagger's name, email, and
+    # the date when the tag was created, along with a message.
+    #
     class Tag < AbstractObject
       attr_accessor :name
 
diff --git a/lib/git/path.rb b/lib/git/path.rb
@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
 module Git
+  # A base class that represents and validates a filesystem path
+  #
+  # Use for tracking things relevant to a Git repository, such as the working
+  # directory or index file.
+  #
   class Path
     attr_accessor :path
 
diff --git a/lib/git/remote.rb b/lib/git/remote.rb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Git
+  # A remote in a Git repository
   class Remote
     attr_accessor :name, :url, :fetch_opts
 
diff --git a/lib/git/stash.rb b/lib/git/stash.rb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Git
+  # A stash in a Git repository
   class Stash
     def initialize(base, message, existing = false)
       @base = base
diff --git a/lib/git/worktree.rb b/lib/git/worktree.rb
@@ -3,6 +3,7 @@
 require 'git/path'
 
 module Git
+  # A worktree in a Git repository
   class Worktree
     attr_accessor :full, :dir
 
diff --git a/tests/test_helper.rb b/tests/test_helper.rb
@@ -17,6 +17,11 @@
 
 module Test
   module Unit
+    # A base class for all test cases in this project
+    #
+    # This class provides utility methods for setting up and tearing down test
+    # environments, creating temporary repositories, and mocking the Git binary.
+    #
     class TestCase
       TEST_ROOT = File.expand_path(__dir__)
       TEST_FIXTURES = File.join(TEST_ROOT, 'files')

Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,7 @@ def stats`
`76`	`76`	`}`
`77`	`77`	`end`
`78`	`78`
	`79`	`+ # The changes for a single file within a diff`
`79`	`80`	`class DiffFile`
`80`	`81`	`attr_accessor :patch, :path, :mode, :src, :dst, :type`
`81`	`82`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`	`require 'open3'`
`12`	`12`
`13`	`13`	`module Git`
	`14`	`+ # Internal git operations`
	`15`	`+ # @api private`
`14`	`16`	`class Lib`
`15`	`17`	`# The path to the Git working copy. The default is '"./.git"'.`
`16`	`18`	`#`