Skip to content

Commit

Permalink
📚 Fix many rdoc spelling mistakes
Browse files Browse the repository at this point in the history
I simply enabled vim's `spell` option and looked at each of the files.
  • Loading branch information
nevans committed May 18, 2024
1 parent 119f43a commit bcdf339
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions lib/net/imap.rb
Original file line number Diff line number Diff line change
Expand Up @@ -820,7 +820,7 @@ class << self
#
# ==== Examples
#
# Connect to cleartext port 143 at mail.example.com and recieve the server greeting:
# Connect to cleartext port 143 at mail.example.com and receive the server greeting:
# imap = Net::IMAP.new('mail.example.com', ssl: false) # => #<Net::IMAP:0x00007f79b0872bd0>
# imap.port => 143
# imap.tls_verified? => false
Expand Down Expand Up @@ -888,7 +888,7 @@ def initialize(host, port: nil, ssl: nil,
@greeting = nil
@capabilities = nil

# Client Protocol Reciever
# Client Protocol Receiver
@parser = ResponseParser.new
@responses = Hash.new {|h, k| h[k] = [] }
@response_handlers = []
Expand Down
2 changes: 1 addition & 1 deletion lib/net/imap/data_encoding.rb
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ class << self
alias parse_datetime decode_datetime
alias parse_time decode_time

# alias format_datetime encode_datetime # n.b. this is overridden below...
# alias format_datetime encode_datetime # n.b: this is overridden below...
end

# DEPRECATED:: The original version returned incorrectly formatted strings.
Expand Down
2 changes: 1 addition & 1 deletion lib/net/imap/deprecated_client_options.rb
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ module DeprecatedClientOptions
# deprecated by a future release.
#
# If a second positional argument is given and it is a hash (or is
# convertable via +#to_hash+), it is converted to keyword arguments.
# convertible via +#to_hash+), it is converted to keyword arguments.
#
# # Obsolete:
# Net::IMAP.new("imap.example.com", options_hash)
Expand Down
2 changes: 1 addition & 1 deletion lib/net/imap/errors.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class Error < StandardError
class DataFormatError < Error
end

# Error raised when a response from the server is non-parseable.
# Error raised when a response from the server is non-parsable.
class ResponseParseError < Error
end

Expand Down
2 changes: 1 addition & 1 deletion lib/net/imap/flags.rb
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ class IMAP < Protocol
# Mailbox name attributes are not case-sensitive. <em>The current
# implementation</em> normalizes mailbox attribute case using
# String#capitalize, such as +:Noselect+ (not +:NoSelect+). The constants
# (such as NO_SELECT) can also be used for comparison. The contants have
# (such as NO_SELECT) can also be used for comparison. The constants have
# been defined both with and without underscores between words.
#
# <em>The descriptions here were copied from</em> {[RFC-9051 §
Expand Down
10 changes: 5 additions & 5 deletions lib/net/imap/response_data.rb
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ class UntaggedResponse < Struct.new(:name, :data, :raw_data)

# Net::IMAP::IgnoredResponse represents intentionally ignored responses.
#
# This includes untagged response "NOOP" sent by eg. Zimbra to avoid
# This includes untagged response "NOOP" sent by e.g. Zimbra to avoid
# some clients to close the connection.
#
# It matches no IMAP standard.
Expand Down Expand Up @@ -280,7 +280,7 @@ class ResponseText < Struct.new(:code, :text)
# ==== +QRESYNC+ extension
# See {[RFC7162]}[https://www.rfc-editor.org/rfc/rfc7162.html].
# * +CLOSED+, returned when the currently selected mailbox is closed
# implicity by selecting or examining another mailbox. #data is +nil+.
# implicitly by selecting or examining another mailbox. #data is +nil+.
#
# ==== +IMAP4rev2+ Response Codes
# See {[RFC9051]}[https://www.rfc-editor.org/rfc/rfc9051] {§7.1, "Server
Expand Down Expand Up @@ -1045,7 +1045,7 @@ def media_subtype
# === Bug Analysis
#
# \IMAP body structures are parenthesized lists and assign their fields
# positionally, so missing fields change the intepretation of all
# positionally, so missing fields change the interpretation of all
# following fields. Additionally, different body types have a different
# number of required fields, followed by optional "extension" fields.
#
Expand All @@ -1060,15 +1060,15 @@ def media_subtype
# Normally, +envelope+ and +md5+ are incompatible, but Net::IMAP leniently
# allowed buggy servers to send +NIL+ for +envelope+. As a result, when a
# server sent a <tt>message/rfc822</tt> part with +NIL+ for +md5+ and a
# non-<tt>NIL</tt> +dsp+, Net::IMAP mis-interpreted the
# non-<tt>NIL</tt> +dsp+, Net::IMAP misinterpreted the
# <tt>Content-Disposition</tt> as if it were a strange body type. In all
# reported cases, the <tt>Content-Disposition</tt> was "attachment", so
# BodyTypeAttachment was created as the workaround.
#
# === Current behavior
#
# When interpreted strictly, +envelope+ and +md5+ are incompatible. So the
# current parsing algorithm peeks ahead after it has recieved the seventh
# current parsing algorithm peeks ahead after it has received the seventh
# body field. If the next token is not the start of an +envelope+, we assume
# the server has incorrectly sent us a <tt>body-type-basic</tt> and return
# BodyTypeBasic. As a result, what was previously BodyTypeMessage#body =>
Expand Down
2 changes: 1 addition & 1 deletion lib/net/imap/sasl.rb
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ class IMAP
# See ExternalAuthenticator.
#
# Authenticates using already established credentials, such as a TLS
# certificate or IPsec.
# certificate or IPSec.
#
# +OAUTHBEARER+::
# See OAuthBearerAuthenticator.
Expand Down
2 changes: 1 addition & 1 deletion lib/net/imap/sasl/external_authenticator.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ module SASL
# Net::IMAP#authenticate.
#
# The EXTERNAL mechanism requests that the server use client credentials
# established external to SASL, for example by TLS certificate or IPsec.
# established external to SASL, for example by TLS certificate or IPSec.
class ExternalAuthenticator

# Authorization identity: an identity to act as or on behalf of. The
Expand Down
4 changes: 2 additions & 2 deletions lib/net/imap/sequence_set.rb
Original file line number Diff line number Diff line change
Expand Up @@ -902,8 +902,8 @@ def numbers; each_number.to_a end
# Yields each number or range in #string to the block and returns +self+.
# Returns an enumerator when called without a block.
#
# The entries are yielded in the same order they appear in #tring, with no
# sorting, deduplication, or coalescing. When #string is in its
# The entries are yielded in the same order they appear in #string, with
# no sorting, deduplication, or coalescing. When #string is in its
# normalized form, this will yield the same values as #each_element.
#
# Related: #entries, #each_element
Expand Down

0 comments on commit bcdf339

Please sign in to comment.