docs: Add comment for rdoc

active-hash · Jul 4, 2024 · 45adef8 · 45adef8
1 parent 0540d03
commit 45adef8
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/lib/active_hash/base.rb b/lib/active_hash/base.rb
@@ -50,6 +50,19 @@ def field_names
         @field_names ||= []
       end
 
+      #
+      # Useful for CSV integration needing column names as strings.
+      #
+      # @return [Array<String>] An array of column names as strings.
+      #
+      # @example Usage
+      #  class Country < ActiveHash::Base
+      #    fields :name, :code
+      #  end
+      #
+      #  Country.column_names
+      #  # => ["id", "name", "code"]
+      #
       def column_names
         @column_names ||= field_names.map(&:name)
       end