Skip to content

Commit c265d87

Browse files
authored
Fix typos in the quick help of files (Alamofire#3837)
### Goals ⚽ <!-- List the high-level objectives of this pull request. --> <!-- Include any relevant context. --> - Fix typos in the quick help of `Request.swift`, `ResponseSerialization.swift`, `ServerTrustEvaluation.swift`, `URLEncodedFormEncoder.swift` ### Implementation Details 🚧 <!-- Explain the reasoning behind any architectural changes. --> <!-- Highlight any new functionality. --> 1. `Request.swift` -> `isResumed` |before|after| |--|--| |<img width="350" src="https://github.com/Alamofire/Alamofire/assets/51712973/8a5b9abf-2d66-460d-b831-d5d9ce3f48f9">|<img width="350" src="https://github.com/Alamofire/Alamofire/assets/51712973/68797322-15aa-4ba2-896f-75b3bb757720">| 2. `ResponseSerialization.swift` -> `responseAllowsEmptyResponseData(_:)` |before|after| |--|--| |<img width="350" src="https://github.com/Alamofire/Alamofire/assets/51712973/ceb68e06-19bb-4f3a-a8fa-261fdf646d9f">|<img width="350" src="https://github.com/Alamofire/Alamofire/assets/51712973/4cd98ceb-8de9-4cab-9879-969453536a4f">| 3. `ServerTrustEvaluation.swift` -> `AlamofireExtension` -> `isSuccess` |before|after| |--|--| |<img width="350" src="https://github.com/Alamofire/Alamofire/assets/51712973/aa5ca255-9893-48bc-8a4d-e77a9735eb40">|<img width="350" src="https://github.com/Alamofire/Alamofire/assets/51712973/43180633-4019-47c1-8556-e9ed2610426e">| 4. `URLEncodedFormEncoder.swift` -> `encode(_:)` |before|after| |--|--| |<img width="350" src="https://github.com/Alamofire/Alamofire/assets/51712973/44f0b62f-83c3-4bdf-a126-37a436eef10d">|<img width="350" src="https://github.com/Alamofire/Alamofire/assets/51712973/b3fee803-6bbd-4aca-941e-1551d99f565f">| ### Testing Details 🔍 <!-- Describe what tests you've added for your changes. --> No testing is needed as the change is in the comment.
1 parent e929492 commit c265d87

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

Source/Core/Request.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ public class Request {
131131
public var state: State { mutableState.state }
132132
/// Returns whether `state` is `.initialized`.
133133
public var isInitialized: Bool { state == .initialized }
134-
/// Returns whether `state is `.resumed`.
134+
/// Returns whether `state` is `.resumed`.
135135
public var isResumed: Bool { state == .resumed }
136136
/// Returns whether `state` is `.suspended`.
137137
public var isSuspended: Bool { state == .suspended }

Source/Features/ResponseSerialization.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ extension ResponseSerializer {
128128
.map { emptyRequestMethods.contains($0) }
129129
}
130130

131-
/// Determines whether the `response` allows empty response bodies, if `response` exists`.
131+
/// Determines whether the `response` allows empty response bodies, if `response` exists.
132132
///
133133
/// - Parameter response: `HTTPURLResponse` to evaluate.
134134
///

Source/Features/ServerTrustEvaluation.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -760,7 +760,7 @@ extension AlamofireExtension where ExtendedType == OSStatus {
760760

761761
extension SecTrustResultType: AlamofireExtended {}
762762
extension AlamofireExtension where ExtendedType == SecTrustResultType {
763-
/// Returns whether `self is `.unspecified` or `.proceed`.
763+
/// Returns whether `self` is `.unspecified` or `.proceed`.
764764
public var isSuccess: Bool {
765765
type == .unspecified || type == .proceed
766766
}

Source/Features/URLEncodedFormEncoder.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,7 @@ public final class URLEncodedFormEncoder {
445445

446446
/// Encodes the `value` as a URL form encoded `String`.
447447
///
448-
/// - Parameter value: The `Encodable` value.`
448+
/// - Parameter value: The `Encodable` value.
449449
///
450450
/// - Returns: The encoded `String`.
451451
/// - Throws: An `Error` or `EncodingError` instance if encoding fails.

0 commit comments

Comments
 (0)