Skip to content

Commit

Permalink
📚 Consistent heading levels inside method rdoc
Browse files Browse the repository at this point in the history 
All headings inside Net::IMAP method rdoc have been set to `h4`.  This
assumes that the method documentation is already three levels deep:
* `<h1>` -- the page title, i.e: the class name
* `<h2>` -- the category, i.e: "Instance Methods"
* `<h3>` -- the method name

The first two heading levels _are_ defined on the page, but the third
level is unfortunately output as a `<div>`, not an `<h3>`.
  • Loading branch information
@nevans
nevans committed Dec 14, 2024
1 parent c287366 commit 6c86a07
Showing 1 changed file with 39 additions and 39 deletions.
78 changes: 39 additions & 39 deletions lib/net/imap.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1123,7 +1123,7 @@ def capability
#
# See [ID[https://tools.ietf.org/html/rfc2971]] for field definitions.
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +ID+
# [RFC2971[https://tools.ietf.org/html/rfc2971]].
Expand Down Expand Up @@ -1205,7 +1205,7 @@ def logout!
#
# Related: Net::IMAP.new, #login, #authenticate
#
# ===== Capability
# ==== Capability
# Clients should not call #starttls unless the server advertises the
# +STARTTLS+ capability.
#
Expand Down Expand Up @@ -1352,7 +1352,7 @@ def authenticate(*args, sasl_ir: config.sasl_ir, **props, &callback)
#
# Related: #authenticate, #starttls
#
# ===== Capabilities
# ==== Capabilities
#
# An IMAP client MUST NOT call #login when the server advertises the
# +LOGINDISABLED+ capability. By default, Net::IMAP will raise a
Expand Down Expand Up @@ -1393,7 +1393,7 @@ def login(user, password)
#
# Related: #examine
#
# ===== Capabilities
# ==== Capabilities
#
# If [UIDPLUS[https://www.rfc-editor.org/rfc/rfc4315.html]] is supported,
# the server may return an untagged "NO" response with a "UIDNOTSTICKY"
Expand Down Expand Up @@ -1511,7 +1511,7 @@ def unsubscribe(mailbox)
#
# Related: #lsub, MailboxList
#
# ===== For example:
# ==== For example:
#
# imap.create("foo/bar")
# imap.create("foo/baz")
Expand Down Expand Up @@ -1562,7 +1562,7 @@ def list(refname, mailbox)
#
# Related: #list, Namespaces, Namespace
#
# ===== For example:
# ==== For example:
#
# if capable?("NAMESPACE")
# namespaces = imap.namespace
Expand All @@ -1576,7 +1576,7 @@ def list(refname, mailbox)
# end
# end
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +NAMESPACE+
# [RFC2342[https://tools.ietf.org/html/rfc2342]].
Expand Down Expand Up @@ -1615,7 +1615,7 @@ def namespace
#
# Related: #list, MailboxList
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +XLIST+,
# a deprecated Gmail extension (replaced by +SPECIAL-USE+).
Expand All @@ -1638,7 +1638,7 @@ def xlist(refname, mailbox)
#
# Related: #getquota, #setquota, MailboxQuotaRoot, MailboxQuota
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +QUOTA+
# [RFC2087[https://tools.ietf.org/html/rfc2087]].
Expand All @@ -1659,7 +1659,7 @@ def getquotaroot(mailbox)
#
# Related: #getquotaroot, #setquota, MailboxQuota
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +QUOTA+
# [RFC2087[https://tools.ietf.org/html/rfc2087]].
Expand All @@ -1677,7 +1677,7 @@ def getquota(mailbox)
#
# Related: #getquota, #getquotaroot
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +QUOTA+
# [RFC2087[https://tools.ietf.org/html/rfc2087]].
Expand All @@ -1697,7 +1697,7 @@ def setquota(mailbox, quota)
#
# Related: #getacl
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +ACL+
# [RFC4314[https://tools.ietf.org/html/rfc4314]].
Expand All @@ -1715,7 +1715,7 @@ def setacl(mailbox, user, rights)
#
# Related: #setacl, MailboxACLItem
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +ACL+
# [RFC4314[https://tools.ietf.org/html/rfc4314]].
Expand Down Expand Up @@ -1752,7 +1752,7 @@ def lsub(refname, mailbox)
# for +mailbox+ cannot be returned; for instance, because it
# does not exist.
#
# ===== Supported attributes
# ==== Supported attributes
#
# +MESSAGES+:: The number of messages in the mailbox.
#
Expand Down Expand Up @@ -1783,12 +1783,12 @@ def lsub(refname, mailbox)
# Unsupported attributes may be requested. The attribute value will be
# either an Integer or an ExtensionData object.
#
# ===== For example:
# ==== For example:
#
# p imap.status("inbox", ["MESSAGES", "RECENT"])
# #=> {"RECENT"=>0, "MESSAGES"=>44}
#
# ===== Capabilities
# ==== Capabilities
#
# +SIZE+ requires the server's capabilities to include either +IMAP4rev2+ or
# <tt>STATUS=SIZE</tt>
Expand Down Expand Up @@ -1828,7 +1828,7 @@ def status(mailbox, attr)
# not exist (it is not created automatically), or if the flags,
# date_time, or message arguments contain errors.
#
# ===== Capabilities
# ==== Capabilities
#
# If +UIDPLUS+ [RFC4315[https://www.rfc-editor.org/rfc/rfc4315.html]] is
# supported and the destination supports persistent UIDs, the server's
Expand Down Expand Up @@ -1877,7 +1877,7 @@ def close
#
# Related: #close
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +UNSELECT+
# [RFC3691[https://tools.ietf.org/html/rfc3691]].
Expand Down Expand Up @@ -1918,7 +1918,7 @@ def expunge
#
# Related: #expunge
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +UIDPLUS+
# [RFC4315[https://www.rfc-editor.org/rfc/rfc4315.html]].
Expand Down Expand Up @@ -2249,7 +2249,7 @@ def uid_search(...)
#
# Related: #uid_search, FetchData
#
# ===== For example:
# ==== For example:
#
# p imap.fetch(6..8, "UID")
# #=> [#<Net::IMAP::FetchData seqno=6, attr={"UID"=>98}>, \\
Expand All @@ -2267,7 +2267,7 @@ def uid_search(...)
# p data.attr["UID"]
# #=> 98
#
# ===== Capabilities
# ==== Capabilities
#
# Many extensions define new message +attr+ names. See FetchData for a list
# of supported extension fields.
Expand Down Expand Up @@ -2296,7 +2296,7 @@ def fetch(set, attr, mod = nil, changedsince: nil)
#
# Related: #fetch, FetchData
#
# ===== Capabilities
# ==== Capabilities
# Same as #fetch.
def uid_fetch(set, attr, mod = nil, changedsince: nil)
fetch_internal("UID FETCH", set, attr, mod, changedsince: changedsince)
Expand Down Expand Up @@ -2330,14 +2330,14 @@ def uid_fetch(set, attr, mod = nil, changedsince: nil)
#
# Related: #uid_store
#
# ===== For example:
# ==== For example:
#
# p imap.store(6..8, "+FLAGS", [:Deleted])
# #=> [#<Net::IMAP::FetchData seqno=6, attr={"FLAGS"=>[:Seen, :Deleted]}>,
# #<Net::IMAP::FetchData seqno=7, attr={"FLAGS"=>[:Seen, :Deleted]}>,
# #<Net::IMAP::FetchData seqno=8, attr={"FLAGS"=>[:Seen, :Deleted]}>]
#
# ===== Capabilities
# ==== Capabilities
#
# Extensions may define new data items to be used with #store.
#
Expand All @@ -2361,7 +2361,7 @@ def store(set, attr, flags, unchangedsince: nil)
#
# Related: #store
#
# ===== Capabilities
# ==== Capabilities
# Same as #store.
def uid_store(set, attr, flags, unchangedsince: nil)
store_internal("UID STORE", set, attr, flags, unchangedsince: unchangedsince)
Expand All @@ -2374,7 +2374,7 @@ def uid_store(set, attr, flags, unchangedsince: nil)
#
# Related: #uid_copy
#
# ===== Capabilities
# ==== Capabilities
#
# If +UIDPLUS+ [RFC4315[https://www.rfc-editor.org/rfc/rfc4315.html]] is
# supported, the server's response should include a +COPYUID+ response code
Expand All @@ -2391,7 +2391,7 @@ def copy(set, mailbox)
#
# Similar to #copy, but +set+ contains unique identifiers.
#
# ===== Capabilities
# ==== Capabilities
#
# +UIDPLUS+ affects #uid_copy the same way it affects #copy.
def uid_copy(set, mailbox)
Expand All @@ -2406,7 +2406,7 @@ def uid_copy(set, mailbox)
#
# Related: #uid_move
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +MOVE+
# [RFC6851[https://tools.ietf.org/html/rfc6851]].
Expand All @@ -2430,7 +2430,7 @@ def move(set, mailbox)
#
# Related: #move
#
# ===== Capabilities
# ==== Capabilities
#
# Same as #move: The server's capabilities must include +MOVE+
# [RFC6851[https://tools.ietf.org/html/rfc6851]]. +UIDPLUS+ also affects
Expand All @@ -2450,14 +2450,14 @@ def uid_move(set, mailbox)
#
# Related: #uid_sort, #search, #uid_search, #thread, #uid_thread
#
# ===== For example:
# ==== For example:
#
# p imap.sort(["FROM"], ["ALL"], "US-ASCII")
# #=> [1, 2, 3, 5, 6, 7, 8, 4, 9]
# p imap.sort(["DATE"], ["SUBJECT", "hello"], "US-ASCII")
# #=> [6, 7, 8, 1]
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +SORT+
# [RFC5256[https://tools.ietf.org/html/rfc5256]].
Expand All @@ -2472,7 +2472,7 @@ def sort(sort_keys, search_keys, charset)
#
# Related: #sort, #search, #uid_search, #thread, #uid_thread
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +SORT+
# [RFC5256[https://tools.ietf.org/html/rfc5256]].
Expand All @@ -2497,7 +2497,7 @@ def uid_sort(sort_keys, search_keys, charset)
#
# Related: #uid_thread, #search, #uid_search, #sort, #uid_sort
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +THREAD+
# [RFC5256[https://tools.ietf.org/html/rfc5256]].
Expand All @@ -2511,7 +2511,7 @@ def thread(algorithm, search_keys, charset)
#
# Related: #thread, #search, #uid_search, #sort, #uid_sort
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +THREAD+
# [RFC5256[https://tools.ietf.org/html/rfc5256]].
Expand All @@ -2530,7 +2530,7 @@ def uid_thread(algorithm, search_keys, charset)
#
# Related: #capable?, #capabilities, #capability
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include
# +ENABLE+ [RFC5161[https://tools.ietf.org/html/rfc5161]]
Expand Down Expand Up @@ -2632,7 +2632,7 @@ def enable(*capabilities)
#
# Related: #idle_done, #noop, #check
#
# ===== Capabilities
# ==== Capabilities
#
# The server's capabilities must include +IDLE+
# [RFC2177[https://tools.ietf.org/html/rfc2177]].
Expand Down Expand Up @@ -2749,7 +2749,7 @@ def idle_done
#
# Related: #extract_responses, #clear_responses, #response_handlers, #greeting
#
# ===== Thread safety
# ==== Thread safety
# >>>
# *Note:* Access to the responses hash is synchronized for thread-safety.
# The receiver thread and response_handlers cannot process new responses
Expand All @@ -2763,7 +2763,7 @@ def idle_done
# thread, but will not modify any responses after adding them to the
# responses hash.
#
# ===== Clearing responses
# ==== Clearing responses
#
# Previously unhandled responses are automatically cleared before entering a
# mailbox with #select or #examine. Long-lived connections can receive many
Expand All @@ -2772,7 +2772,7 @@ def idle_done
# the block, or remove responses with #extract_responses, #clear_responses,
# or #add_response_handler.
#
# ===== Missing responses
# ==== Missing responses
#
# Only non-+nil+ data is stored. Many important response codes have no data
# of their own, but are used as "tags" on the ResponseText object they are
Expand Down

0 comments on commit 6c86a07

Please sign in to comment.