From 05fda6c29f0fe4742b7ea6b237ea98f737b68b8b Mon Sep 17 00:00:00 2001
From: Szymon Szukalski <szymon@skas.io>
Date: Fri, 25 Oct 2024 10:00:36 +1100
Subject: Document code with YARD

---
 lib/gender.rb | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'lib/gender.rb')

diff --git a/lib/gender.rb b/lib/gender.rb
index 9bd3b06..a4f1b60 100644
--- a/lib/gender.rb
+++ b/lib/gender.rb
@@ -1,13 +1,24 @@
 # frozen_string_literal: true
 
+# Gender class to handle gender-related operations.
 class Gender
+  # Constant representing male gender.
   MALE = 'male'
+
+  # Constant representing female gender.
   FEMALE = 'female'
 
+  # Returns all defined genders.
+  #
+  # @return [Array<String>] An array of all genders.
   def self.all
     [MALE, FEMALE]
   end
 
+  # Checks if the provided gender is valid.
+  #
+  # @param gender [String] The gender to validate.
+  # @return [Boolean] True if the gender is valid, false otherwise.
   def self.valid?(gender)
     return false unless gender.is_a?(String)
 
-- 
cgit v1.2.3