Skip to content

Commit 21ab214

Browse files
authored
🔀 Merge pull request #279 from nevans/fix-receive-typos
📚 Fix many rdoc spelling mistakes
2 parents 1e51033 + bcdf339 commit 21ab214

File tree

9 files changed

+15
-15
lines changed

9 files changed

+15
-15
lines changed

lib/net/imap.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -820,7 +820,7 @@ class << self
820820
#
821821
# ==== Examples
822822
#
823-
# Connect to cleartext port 143 at mail.example.com and recieve the server greeting:
823+
# Connect to cleartext port 143 at mail.example.com and receive the server greeting:
824824
# imap = Net::IMAP.new('mail.example.com', ssl: false) # => #<Net::IMAP:0x00007f79b0872bd0>
825825
# imap.port => 143
826826
# imap.tls_verified? => false
@@ -888,7 +888,7 @@ def initialize(host, port: nil, ssl: nil,
888888
@greeting = nil
889889
@capabilities = nil
890890

891-
# Client Protocol Reciever
891+
# Client Protocol Receiver
892892
@parser = ResponseParser.new
893893
@responses = Hash.new {|h, k| h[k] = [] }
894894
@response_handlers = []

lib/net/imap/data_encoding.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ class << self
136136
alias parse_datetime decode_datetime
137137
alias parse_time decode_time
138138

139-
# alias format_datetime encode_datetime # n.b. this is overridden below...
139+
# alias format_datetime encode_datetime # n.b: this is overridden below...
140140
end
141141

142142
# DEPRECATED:: The original version returned incorrectly formatted strings.

lib/net/imap/deprecated_client_options.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ module DeprecatedClientOptions
2020
# deprecated by a future release.
2121
#
2222
# If a second positional argument is given and it is a hash (or is
23-
# convertable via +#to_hash+), it is converted to keyword arguments.
23+
# convertible via +#to_hash+), it is converted to keyword arguments.
2424
#
2525
# # Obsolete:
2626
# Net::IMAP.new("imap.example.com", options_hash)

lib/net/imap/errors.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ class Error < StandardError
1111
class DataFormatError < Error
1212
end
1313

14-
# Error raised when a response from the server is non-parseable.
14+
# Error raised when a response from the server is non-parsable.
1515
class ResponseParseError < Error
1616
end
1717

lib/net/imap/flags.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ class IMAP < Protocol
7171
# Mailbox name attributes are not case-sensitive. <em>The current
7272
# implementation</em> normalizes mailbox attribute case using
7373
# String#capitalize, such as +:Noselect+ (not +:NoSelect+). The constants
74-
# (such as NO_SELECT) can also be used for comparison. The contants have
74+
# (such as NO_SELECT) can also be used for comparison. The constants have
7575
# been defined both with and without underscores between words.
7676
#
7777
# <em>The descriptions here were copied from</em> {[RFC-9051 §

lib/net/imap/response_data.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ class UntaggedResponse < Struct.new(:name, :data, :raw_data)
5858

5959
# Net::IMAP::IgnoredResponse represents intentionally ignored responses.
6060
#
61-
# This includes untagged response "NOOP" sent by eg. Zimbra to avoid
61+
# This includes untagged response "NOOP" sent by e.g. Zimbra to avoid
6262
# some clients to close the connection.
6363
#
6464
# It matches no IMAP standard.
@@ -280,7 +280,7 @@ class ResponseText < Struct.new(:code, :text)
280280
# ==== +QRESYNC+ extension
281281
# See {[RFC7162]}[https://www.rfc-editor.org/rfc/rfc7162.html].
282282
# * +CLOSED+, returned when the currently selected mailbox is closed
283-
# implicity by selecting or examining another mailbox. #data is +nil+.
283+
# implicitly by selecting or examining another mailbox. #data is +nil+.
284284
#
285285
# ==== +IMAP4rev2+ Response Codes
286286
# See {[RFC9051]}[https://www.rfc-editor.org/rfc/rfc9051] {§7.1, "Server
@@ -1045,7 +1045,7 @@ def media_subtype
10451045
# === Bug Analysis
10461046
#
10471047
# \IMAP body structures are parenthesized lists and assign their fields
1048-
# positionally, so missing fields change the intepretation of all
1048+
# positionally, so missing fields change the interpretation of all
10491049
# following fields. Additionally, different body types have a different
10501050
# number of required fields, followed by optional "extension" fields.
10511051
#
@@ -1060,15 +1060,15 @@ def media_subtype
10601060
# Normally, +envelope+ and +md5+ are incompatible, but Net::IMAP leniently
10611061
# allowed buggy servers to send +NIL+ for +envelope+. As a result, when a
10621062
# server sent a <tt>message/rfc822</tt> part with +NIL+ for +md5+ and a
1063-
# non-<tt>NIL</tt> +dsp+, Net::IMAP mis-interpreted the
1063+
# non-<tt>NIL</tt> +dsp+, Net::IMAP misinterpreted the
10641064
# <tt>Content-Disposition</tt> as if it were a strange body type. In all
10651065
# reported cases, the <tt>Content-Disposition</tt> was "attachment", so
10661066
# BodyTypeAttachment was created as the workaround.
10671067
#
10681068
# === Current behavior
10691069
#
10701070
# When interpreted strictly, +envelope+ and +md5+ are incompatible. So the
1071-
# current parsing algorithm peeks ahead after it has recieved the seventh
1071+
# current parsing algorithm peeks ahead after it has received the seventh
10721072
# body field. If the next token is not the start of an +envelope+, we assume
10731073
# the server has incorrectly sent us a <tt>body-type-basic</tt> and return
10741074
# BodyTypeBasic. As a result, what was previously BodyTypeMessage#body =>

lib/net/imap/sasl.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class IMAP
3737
# See ExternalAuthenticator.
3838
#
3939
# Authenticates using already established credentials, such as a TLS
40-
# certificate or IPsec.
40+
# certificate or IPSec.
4141
#
4242
# +OAUTHBEARER+::
4343
# See OAuthBearerAuthenticator.

lib/net/imap/sasl/external_authenticator.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ module SASL
99
# Net::IMAP#authenticate.
1010
#
1111
# The EXTERNAL mechanism requests that the server use client credentials
12-
# established external to SASL, for example by TLS certificate or IPsec.
12+
# established external to SASL, for example by TLS certificate or IPSec.
1313
class ExternalAuthenticator
1414

1515
# Authorization identity: an identity to act as or on behalf of. The

lib/net/imap/sequence_set.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -902,8 +902,8 @@ def numbers; each_number.to_a end
902902
# Yields each number or range in #string to the block and returns +self+.
903903
# Returns an enumerator when called without a block.
904904
#
905-
# The entries are yielded in the same order they appear in #tring, with no
906-
# sorting, deduplication, or coalescing. When #string is in its
905+
# The entries are yielded in the same order they appear in #string, with
906+
# no sorting, deduplication, or coalescing. When #string is in its
907907
# normalized form, this will yield the same values as #each_element.
908908
#
909909
# Related: #entries, #each_element

0 commit comments

Comments
 (0)