📚 Workaround rdoc issue with :yield: and visibility

nevans · nevans · commit 9715b4b22697 · 2023-12-27T19:38:15.000-05:00
Rdoc seems to get confused with the yield in this method.  It somehow
causes all of private methods to be documented as public.  Adding
`:yield:` fixes it.  (I think that changing the block containing yield
to be multiline _also_ fixes it, but this yield needed better docs
anyway.)
diff --git a/lib/net/imap/sequence_set.rb b/lib/net/imap/sequence_set.rb
@@ -907,7 +907,7 @@ def numbers; each_number.to_a end
       # normalized form, this will yield the same values as #each_element.
       #
       # Related: #entries, #each_element
-      def each_entry(&block)
+      def each_entry(&block) # :yields: integer or range or :*
         return to_enum(__method__) unless block_given?
         return each_element(&block) unless @string
         @string.split(",").each do yield tuple_to_entry str_to_tuple _1 end

Original file line number	Diff line number	Diff line change
`@@ -907,7 +907,7 @@ def numbers; each_number.to_a end`
`907`	`907`	`# normalized form, this will yield the same values as #each_element.`
`908`	`908`	`#`
`909`	`909`	`# Related: #entries, #each_element`
`910`		`- def each_entry(&block)`
	`910`	`+ def each_entry(&block) # :yields: integer or range or :*`
`911`	`911`	`return to_enum(__method__) unless block_given?`
`912`	`912`	`return each_element(&block) unless @string`
`913`	`913`	`@string.split(",").each do yield tuple_to_entry str_to_tuple _1 end`