Skip to content

Commit 48bec30

Browse files
authored
docs: add back SDK init links under Topics section (#400)
* docs: add back SDK init links under Topics section * switch codecov back to auto
1 parent 4909de3 commit 48bec30

File tree

5 files changed

+23
-6
lines changed

5 files changed

+23
-6
lines changed

.codecov.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ coverage:
66
status:
77
patch:
88
default:
9-
target: 83
9+
target: auto
1010
changes: false
1111
project:
1212
default:

Sources/ParseSwift/Documentation.docc/ParseSwift.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ To learn how to use or experiment with ParseSwift, you can run and edit the [Par
1111

1212
### Initialize the SDK
1313

14-
- ``ParseSwift/ParseSwift/initialize(configuration:)``
15-
- ``ParseSwift/ParseSwift/initialize(applicationId:clientKey:masterKey:serverURL:liveQueryServerURL:allowingCustomObjectIds:usingTransactions:usingEqualQueryConstraint:keyValueStore:requestCachePolicy:cacheMemoryCapacity:cacheDiskCapacity:migratingFromObjcSDK:deletingKeychainIfNeeded:httpAdditionalHeaders:maxConnectionAttempts:authentication:)``
14+
- ``ParseSwift/initialize(configuration:)``
15+
- ``ParseSwift/initialize(applicationId:clientKey:masterKey:serverURL:liveQueryServerURL:allowingCustomObjectIds:usingTransactions:usingEqualQueryConstraint:usingPostForQuery:keyValueStore:requestCachePolicy:cacheMemoryCapacity:cacheDiskCapacity:usingDataProtectionKeychain:deletingKeychainIfNeeded:httpAdditionalHeaders:maxConnectionAttempts:authentication:)``
1616

Sources/ParseSwift/Parse.swift

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,11 @@ public var configuration: ParseConfiguration {
8686
Configure the Parse Swift client. This should only be used when starting your app. Typically in the
8787
`application(... didFinishLaunchingWithOptions launchOptions...)`.
8888
- parameter configuration: The Parse configuration.
89+
- warning: It is recomended to only specify `masterKey` when using the SDK on a server. Do not use this key on the client.
90+
- warning: `usingTransactions` is experimental.
91+
- warning: Setting `usingPostForQuery` to **true** will require all queries to access the server instead of following the `requestCachePolicy`.
92+
- warning: Setting `usingDataProtectionKeychain` to **true** is known to cause issues in Playgrounds or in
93+
situtations when apps do not have credentials to setup a Keychain.
8994
*/
9095
public func initialize(configuration: ParseConfiguration) {
9196
Parse.configuration = configuration

Sources/ParseSwift/Types/ParseConfiguration.swift

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,15 @@ import FoundationNetworking
1313

1414
// swiftlint:disable line_length
1515

16-
/// The Configuration for a Parse client.
17-
/// - warning: It is recomended to only specify `masterKey` when using the
18-
/// SDK on a server. Do not use this key on the client.
16+
/**
17+
The Configuration for a Parse client.
18+
19+
- warning: It is recomended to only specify `masterKey` when using the SDK on a server. Do not use this key on the client.
20+
- warning: `usingTransactions` is experimental.
21+
- warning: Setting `usingPostForQuery` to **true** will require all queries to access the server instead of following the `requestCachePolicy`.
22+
- warning: Setting `usingDataProtectionKeychain` to **true** is known to cause issues in Playgrounds or in
23+
situtations when apps do not have credentials to setup a Keychain.
24+
*/
1925
public struct ParseConfiguration {
2026

2127
/// The application id for your Parse application.

Tests/ParseSwiftTests/ParseLiveQueryTests.swift

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1672,6 +1672,8 @@ class ParseLiveQueryTests: XCTestCase {
16721672
guard let isSubscribed = try? client.isSubscribed(query),
16731673
let isPending = try? client.isPendingSubscription(query) else {
16741674
XCTFail("Shound unwrap")
1675+
expectation1.fulfill()
1676+
expectation2.fulfill()
16751677
return
16761678
}
16771679
XCTAssertTrue(isSubscribed)
@@ -1685,6 +1687,8 @@ class ParseLiveQueryTests: XCTestCase {
16851687
installationId: "naw")
16861688
guard let encoded = try? ParseCoding.jsonEncoder().encode(response) else {
16871689
XCTFail("Should encode")
1690+
expectation1.fulfill()
1691+
expectation2.fulfill()
16881692
return
16891693
}
16901694
client.received(encoded)
@@ -1754,6 +1758,8 @@ class ParseLiveQueryTests: XCTestCase {
17541758
installationId: "naw")
17551759
guard let encoded = try? ParseCoding.jsonEncoder().encode(response) else {
17561760
XCTFail("Should have encoded")
1761+
expectation1.fulfill()
1762+
expectation2.fulfill()
17571763
return
17581764
}
17591765
client.received(encoded)

0 commit comments

Comments
 (0)