fix: connect_database doc string

fortress-build · Aug 22, 2024 · 7246a61 · 7246a61
1 parent 2f6fba3
commit 7246a61
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/fortress.rb b/lib/fortress.rb
@@ -87,6 +87,9 @@ def delete_tenant(id)
       _ = make_request(:delete, endpoint)
     end
 
+    # Connect to a database.
+    # @param id [String] The database ID.
+    # @return [PG::Connection] The connection to the database.
     def connect_database(id)
       connection_details = get_connection_uri(id, 'database')
       PG::Connection.new(dbname: connection_details.database, user: connection_details.username,