Skip to content

Commit

Permalink
Fix documentation for fetchDeviceCode and polling
Browse files Browse the repository at this point in the history
  • Loading branch information
dcaunt committed Apr 3, 2024
1 parent 9baa6f4 commit 23d1741
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion Sources/OpenPass/DeviceAuthorizationFlow.swift
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,8 @@ public final class DeviceAuthorizationFlow {
// MARK: - Public API

/// Start the authorization flow by requesting a Device Code from the API server.
/// The returned ``DeviceCode`` is also used with the `fetchAccessToken` and`fetchAccessTokenPolling` methods.
/// The ``DeviceCode`` contains values for presentation in your user interface.
/// A ``DeviceCode`` is also used with the `fetchAccessToken(deviceCode:)` method to check for authorization.
/// - Returns: A Device Code representation
public func fetchDeviceCode() async throws -> DeviceCode {
// Reset in case the flow is reused
Expand Down

0 comments on commit 23d1741

Please sign in to comment.