📚 Add rdoc for FetchStruct#attr

ruby · Jan 4, 2025 · 1e4e296 · 1e4e296
1 parent 475c5fc
commit 1e4e296
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/lib/net/imap/fetch_data.rb b/lib/net/imap/fetch_data.rb
@@ -103,6 +103,15 @@ class IMAP < Protocol
     #   as <tt>BODY[#{specifier}]</tt> or <tt>BINARY[#{section}]</tt>.
     #
     class FetchStruct < Struct
+      ##
+      # method: attr
+      # :call-seq: attr -> hash
+      #
+      # Each key specifies a message attribute, and the value is the
+      # corresponding data item.  Standard data items have corresponding
+      # accessor methods.  The definitions of each attribute type is documented
+      # on its accessor.
+
       # :call-seq: attr_upcase -> hash
       #
       # A transformation of #attr, with all the keys converted to upper case.