Skip to content

Commit 263f093

Browse files
committed
Fix broken links in DocC
1 parent f684f74 commit 263f093

5 files changed

Lines changed: 6 additions & 5 deletions

File tree

Sources/ATProtoKit/ATProtoKit.docc/Authentication/OAuthIntegration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ let context = SessionAuthorizationContext(
160160

161161
## Register a restored or newly authorized session
162162

163-
Call ``ATOAuthSessionConfiguration/registerSession()`` after authorization or restoration and before using authenticated ATProtoKit methods. Registration validates and publishes the account decentralized identifier (DID) and provider-supplied PDS endpoint. ``ATProtoKit/createOAuthSession(sessionConfiguration:apiClientConfiguration:canUseBlueskyRecords:)`` performs registration and client construction as one checked operation:
163+
Call ``ATOAuthSessionConfiguration/registerSession()`` after authorization or restoration and before using authenticated ATProtoKit methods. Registration validates and publishes the account decentralized identifier (DID) and provider-supplied PDS endpoint. ``ATProtoKit/createOAuthSession(sessionConfiguration:apiClientConfiguration:atidentityResolver:canUseBlueskyRecords:)`` performs registration and client construction as one checked operation:
164164

165165
```swift
166166
let client = try await ATProtoKit.createOAuthSession(

Sources/ATProtoKit/ATProtoKit.docc/Authentication/SessionConfigurationArticle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ It also offers these request-time extension points:
4848
- ``SessionConfiguration/authorizationContext()`` defaults to deriving a context from the
4949
``UserSession`` registered under `instanceUUID`.
5050

51-
The `pdsURL` property is a bootstrap value and does not change when a session is registered. Code that constructs an ATProtoKit client manually after loading a dynamic context must pass the registered context's `serviceEndpoint`. ``ATProtoKit/createOAuthSession(sessionConfiguration:apiClientConfiguration:canUseBlueskyRecords:)`` does this automatically for ``ATOAuthSessionConfiguration``.
51+
The `pdsURL` property is a bootstrap value and does not change when a session is registered. Code that constructs an ATProtoKit client manually after loading a dynamic context must pass the registered context's `serviceEndpoint`. ``ATProtoKit/createOAuthSession(sessionConfiguration:apiClientConfiguration:atidentityResolver:canUseBlueskyRecords:)`` does this automatically for ``ATOAuthSessionConfiguration``.
5252

5353
## Add lifecycle capabilities deliberately
5454

Sources/ATProtoKit/ATProtoKit.docc/Overview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ ATProtoKit is fully open source under the [MIT license](https://github.com/Maste
156156
- ``ATFacetParser``
157157
- ``SessionToken``
158158
- ``ATRecordDecoder``
159+
- ``ATLexiconKnownValue``
159160
- ``ATBuiltInIdentityResolver``
160161
- ``AttachmentLexiconLimit``
161162
- ``Truncatable``

Sources/ATProtoKit/ATProtoKit.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ public final class ATProtoKit: Sendable, ATProtoKitConfiguration, ATRecordConfig
172172
/// - sessionConfiguration: The authenticated user session within the AT Protocol. Optional.
173173
/// - apiClientConfiguration: An ``APIClientConfiguration`` object. Optional.
174174
/// - atidentityResolver: An instance of ``ATIdentityProtocol`` to perform
175-
/// Personal Data Server (PDS) resolutions. Defaults to ``ATBuiltInIdentityResolver()``.
175+
/// Personal Data Server (PDS) resolutions. Defaults to ``ATBuiltInIdentityResolver``.
176176
/// Defaults to `nil`. When `sessionConfiguration` supplies an executor that owns OAuth
177177
/// authorization, that executor takes precedence over this configuration's response provider.
178178
/// - pdsURL: The URL of the Personal Data Server (PDS). Defaults to ``APIHostname/bskyAppView``.
@@ -221,7 +221,7 @@ public final class ATProtoKit: Sendable, ATProtoKitConfiguration, ATRecordConfig
221221
/// - sessionConfiguration: The external OAuth session configuration to register and use.
222222
/// - apiClientConfiguration: Additional API client configuration. Optional. Defaults to `nil`.
223223
/// - atidentityResolver: An instance of ``ATIdentityProtocol`` to perform
224-
/// Personal Data Server (PDS) resolutions. Defaults to ``ATBuiltInIdentityResolver()``.
224+
/// Personal Data Server (PDS) resolutions. Defaults to ``ATBuiltInIdentityResolver``.
225225
/// - canUseBlueskyRecords: Indicates whether Bluesky lexicon record types should be registered.
226226
/// Defaults to `true`.
227227
/// - Returns: An authenticated ATProtoKit client using the registered OAuth session.

Sources/ATProtoKit/Models/Common/ATLexiconKnownValue.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ extension ATLexiconKnownValue {
2222

2323
/// Creates the value from a `String` literal.
2424
///
25-
/// - Parameter stringLiteral: The string value used to initialize the type from a string literal.
25+
/// - Parameter value: The string value used to initialize the type from a string literal.
2626
public init(stringLiteral value: String) {
2727
self.init(rawValue: value)
2828
}

0 commit comments

Comments
 (0)