Document code with YARD

1 files changed, 9 insertions, 0 deletions

diff --git a/lib/relationship_manager.rb b/lib/relationship_manager.rb
index 08d87e1..30dfd94 100644
--- a/lib/relationship_manager.rb
+++ b/lib/relationship_manager.rb
@@ -2,9 +2,18 @@
 
 require 'singleton'
 
+# RelationshipManager class to manage relationships between people.
+# This class follows the Singleton pattern to ensure there is only one instance
+# of the relationship manager throughout the application.
 class RelationshipManager
   include Singleton
 
+  # Links two people as spouses.
+  #
+  # @param person1 [Person] The first person to link.
+  # @param person2 [Person] The second person to link.
+  # @raise [RuntimeError] if either person is already linked to someone else.
+  # @return [void]
   def link_spouses(person1, person2)
     # Check if either person is already linked to someone else
     if person1.spouse != NilPerson.new && person1.spouse != person2