Skip to content

Commit 62957ed

Browse files
committed
📚️ Fix ghost method: directives broken by rdoc 8.0
rdoc v8.0 silently dropped support for using the `method:` directive without a leading colon. As it turns out, I used the `method:` directive a _lot_. See ruby/rdoc#1760.
1 parent cc07c14 commit 62957ed

5 files changed

Lines changed: 93 additions & 93 deletions

File tree

lib/net/imap/config.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ def self.[](config)
196196
# #load_defaults will not override #debug.
197197
attr_accessor :debug, type: :boolean, default: false
198198

199-
# method: debug?
199+
# :method: debug?
200200
# :call-seq: debug? -> boolean
201201
#
202202
# Alias for #debug

lib/net/imap/esearch_result.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,11 +193,11 @@ def initialize(range:, results:)
193193
end
194194

195195
##
196-
# method: range
196+
# :method: range
197197
# :call-seq: range -> range
198198

199199
##
200-
# method: results
200+
# :method: results
201201
# :call-seq: results -> sequence set or nil
202202

203203
# Converts #results to an array of integers.

lib/net/imap/fetch_data.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ class IMAP < Protocol
104104
#
105105
class FetchStruct < Struct
106106
##
107-
# method: attr
107+
# :method: attr
108108
# :call-seq: attr -> hash
109109
#
110110
# Each key specifies a message attribute, and the value is the
@@ -518,7 +518,7 @@ def section_attr(attr, part = [], text = nil, offset: nil)
518518
# See FetchStruct documentation for a list of standard message attributes.
519519
class FetchData < FetchStruct.new(:seqno, :attr)
520520
##
521-
# method: seqno
521+
# :method: seqno
522522
# :call-seq: seqno -> Integer
523523
#
524524
# The message sequence number.
@@ -532,7 +532,7 @@ class FetchData < FetchStruct.new(:seqno, :attr)
532532
# UIDFetchData will raise a NoMethodError.
533533

534534
##
535-
# method: attr
535+
# :method: attr
536536
# :call-seq: attr -> hash
537537
#
538538
# Each key specifies a message attribute, and the value is the
@@ -558,7 +558,7 @@ class FetchData < FetchStruct.new(:seqno, :attr)
558558
# See FetchStruct documentation for a list of standard message attributes.
559559
class UIDFetchData < FetchStruct.new(:uid, :attr)
560560
##
561-
# method: uid
561+
# :method: uid
562562
# call-seq: uid -> Integer
563563
#
564564
# A number expressing the unique identifier of the message.
@@ -568,7 +568,7 @@ class UIDFetchData < FetchStruct.new(:uid, :attr)
568568
# returns the uniqueid at the beginning of the +UIDFETCH+ response.
569569

570570
##
571-
# method: attr
571+
# :method: attr
572572
# call-seq: attr -> hash
573573
#
574574
# Each key specifies a message attribute, and the value is the

0 commit comments

Comments
 (0)