Tiny comment improvement in Sisimai::Fact.rise()

sisimai · Aug 25, 2024 · c4c9712 · c4c9712
1 parent f992c0c
commit c4c9712
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/lib/sisimai/fact.rb b/lib/sisimai/fact.rb
@@ -93,9 +93,9 @@ def initialize(argvs)
     # Constructor of Sisimai::Fact
     # @param         [Hash]   argvs
     # @options argvs [String]  data       Entire email message
-    # @options argvs [Boolean] delivered  Include the result which has "delivered" reason
-    # @options argvs [Boolean] vacation   Include the result which has "vacation" reason
-    # @options argvs [Proc]    hook       Proc object of callback method
+    # @options argvs [Boolean] delivered  true if the result which has "delivered" reason is included
+    # @options argvs [Boolean] vacation   true if the result which has "vacation" reason is included
+    # @options argvs [Proc]    hook       Proc object of the callback method
     # @options argvs [String]  origin     Path to the original email file
     # @return        [Array]              Array of Sisimai::Fact objects
     def self.rise(**argvs)