Skip to content

Commit

Permalink
Refine wording in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yllfejziu committed May 2, 2024
1 parent 43b1407 commit 56e0b0f
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions Sources/Apple/AppleAuthenticator.swift
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ public final class AppleAuthenticator: NSObject {
extension AppleAuthenticator: Authenticator {
/// SignIn user
///
/// Will asynchronously return the `Response` object on success or with `Error` on error.
/// Will asynchronously return the `Response` object on success or `Error` on error.
public func signIn(from presentingViewController: UIViewController) async throws -> Response {
try await appleSignIn(on: presentingViewController, with: nil)
}

/// SignIn user with `nonce` value
///
/// Nonce is usually needed when doing auth with an external auth provider (e.g. firebase).
/// Will asynchronously return the `Response` object on success or with `Error` on error.
/// Will asynchronously return the `Response` object on success or `Error` on error.
public func signIn(from presentingViewController: UIViewController, with nonce: Nonce) async throws -> Response {
try await appleSignIn(on: presentingViewController, with: nonce)
}
Expand Down
2 changes: 1 addition & 1 deletion Sources/Facebook/FacebookAuthenticator.swift
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ extension FacebookAuthenticator: Authenticator {
/// SignIn user.
///
/// The `permissions` to use when doing a sign in.
/// Will asynchronously return the `Response` object on success or with `Error` on error.
/// Will asynchronously return the `Response` object on success or `Error` on error.
public func signIn(
from presentingViewController: UIViewController,
with permissions: [Permission] = [.email, .publicProfile]) async throws -> Response
Expand Down
2 changes: 1 addition & 1 deletion Sources/Google/GoogleAuthenticator.swift
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public final class GoogleAuthenticator {
extension GoogleAuthenticator: Authenticator {
/// SignIn user.
///
/// Will asynchronously return the `Response` object on success or with `Error` on error.
/// Will asynchronously return the `Response` object on success or `Error` on error.
public func signIn(from presentingViewController: UIViewController,
hint: String? = .none,
additionalScopes: [String]? = .none) async throws -> Response {
Expand Down
2 changes: 1 addition & 1 deletion Sources/LinkedIn/LinkedInAuthenticator.swift
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public final class LinkedInAuthenticator {
extension LinkedInAuthenticator: Authenticator {
/// SignIn user.
///
/// Will return promise with the `Response` object on success or with `Error` on error.
/// Will asynchronously return the `Response` object on success or `Error` on error.
public func signIn(authCode: String, configuration: Configuration) async throws -> Response {
let authRequest: LinkedInAPI.LinkedInAuthRequest = .init(
code: authCode,
Expand Down

0 comments on commit 56e0b0f

Please sign in to comment.