Skip to content

Commit da3fb65

Browse files
cbaker6cbaker6
authored
docs: improve batch documentation (#15)
* docs: improve batch documentation * validate codecov file * fix codecov
1 parent 57de231 commit da3fb65

16 files changed

+59
-58
lines changed

‎.codecov.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
coverage:
22
ignore:
3-
- Tests/ParseSwiftTests/.*
3+
- Tests/*
44
- TestHost/*
55
- TestHostTV/*
66
status:
@@ -10,6 +10,6 @@ coverage:
1010
changes: false
1111
project:
1212
default:
13-
target: 89
13+
target: 90
1414
comment:
1515
require_changes: true

‎.github/workflows/ci.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,7 @@ jobs:
188188
run: swift test --enable-test-discovery --enable-code-coverage -v
189189
- name: Prepare codecov
190190
run: |
191+
cat .codecov.yml | curl --data-binary @- https://codecov.io/validate
191192
llvm-cov export -format="lcov" .build/x86_64-unknown-linux-gnu/debug/ParseSwiftPackageTests.xctest -instr-profile .build/x86_64-unknown-linux-gnu/debug/codecov/default.profdata > info_linux.lcov
192193
- name: Upload coverage to Codecov
193194
uses: codecov/codecov-action@v3

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/4.16.1...main), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/main/documentation/parseswift)
55
* _Contributing to this repo? Add info about your change here to be included in the next release_
66

7-
### 4.16.0
7+
### 4.16.1
88
[Full Changelog](https://github.com/netreconlab/Parse-Swift/compare/4.16.0...4.16.1), [Documentation](https://swiftpackageindex.com/netreconlab/Parse-Swift/4.16.1/documentation/parseswift)
99

1010
__Fixes__

‎Sources/ParseSwift/Objects/ParseInstallation+async.swift‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ public extension Sequence where Element: ParseInstallation {
174174

175175
/**
176176
Saves a collection of installations *asynchronously*.
177-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
177+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
178178
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
179179
Defaults to 50.
180180
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -217,7 +217,7 @@ public extension Sequence where Element: ParseInstallation {
217217

218218
/**
219219
Creates a collection of installations *asynchronously*.
220-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
220+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
221221
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
222222
Defaults to 50.
223223
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -245,7 +245,7 @@ public extension Sequence where Element: ParseInstallation {
245245

246246
/**
247247
Replaces a collection of installations *asynchronously*.
248-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
248+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
249249
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
250250
Defaults to 50.
251251
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -274,7 +274,7 @@ public extension Sequence where Element: ParseInstallation {
274274

275275
/**
276276
Updates a collection of installations *asynchronously*.
277-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
277+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
278278
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
279279
Defaults to 50.
280280
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -303,7 +303,7 @@ public extension Sequence where Element: ParseInstallation {
303303

304304
/**
305305
Deletes a collection of installations *asynchronously*.
306-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
306+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
307307
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
308308
Defaults to 50.
309309
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that

‎Sources/ParseSwift/Objects/ParseInstallation+combine.swift‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ public extension Sequence where Element: ParseInstallation {
170170

171171
/**
172172
Saves a collection of installations *asynchronously* and publishes when complete.
173-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
173+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
174174
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
175175
Defaults to 50.
176176
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -212,7 +212,7 @@ public extension Sequence where Element: ParseInstallation {
212212

213213
/**
214214
Creates a collection of installations *asynchronously* and publishes when complete.
215-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
215+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
216216
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
217217
Defaults to 50.
218218
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -239,7 +239,7 @@ public extension Sequence where Element: ParseInstallation {
239239

240240
/**
241241
Replaces a collection of installations *asynchronously* and publishes when complete.
242-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
242+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
243243
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
244244
Defaults to 50.
245245
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -267,7 +267,7 @@ public extension Sequence where Element: ParseInstallation {
267267

268268
/**
269269
Updates a collection of installations *asynchronously* and publishes when complete.
270-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
270+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
271271
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
272272
Defaults to 50.
273273
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -296,7 +296,7 @@ public extension Sequence where Element: ParseInstallation {
296296

297297
/**
298298
Deletes a collection of installations *asynchronously* and publishes when complete.
299-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
299+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
300300
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
301301
Defaults to 50.
302302
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that

‎Sources/ParseSwift/Objects/ParseInstallation.swift‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1060,7 +1060,7 @@ public extension Sequence where Element: ParseInstallation {
10601060

10611061
/**
10621062
Saves a collection of installations *synchronously* all at once and throws an error if necessary.
1063-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
1063+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
10641064
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
10651065
Defaults to 50.
10661066
- parameter ignoringCustomObjectIdConfig: Ignore checking for `objectId`
@@ -1161,7 +1161,7 @@ public extension Sequence where Element: ParseInstallation {
11611161

11621162
/**
11631163
Saves a collection of installations all at once *asynchronously* and executes the completion block when done.
1164-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
1164+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
11651165
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
11661166
Defaults to 50.
11671167
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -1230,7 +1230,7 @@ public extension Sequence where Element: ParseInstallation {
12301230

12311231
/**
12321232
Creates a collection of installations all at once *asynchronously* and executes the completion block when done.
1233-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
1233+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
12341234
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
12351235
Defaults to 50.
12361236
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -1283,7 +1283,7 @@ public extension Sequence where Element: ParseInstallation {
12831283

12841284
/**
12851285
Replaces a collection of installations all at once *asynchronously* and executes the completion block when done.
1286-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
1286+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
12871287
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
12881288
Defaults to 50.
12891289
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -1337,7 +1337,7 @@ public extension Sequence where Element: ParseInstallation {
13371337

13381338
/**
13391339
Updates a collection of installations all at once *asynchronously* and executes the completion block when done.
1340-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
1340+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
13411341
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
13421342
Defaults to 50.
13431343
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -1625,7 +1625,7 @@ public extension Sequence where Element: ParseInstallation {
16251625

16261626
/**
16271627
Deletes a collection of installations *synchronously* all at once and throws an error if necessary.
1628-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
1628+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
16291629
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
16301630
Defaults to 50.
16311631
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -1672,7 +1672,7 @@ public extension Sequence where Element: ParseInstallation {
16721672

16731673
/**
16741674
Deletes a collection of installations all at once *asynchronously* and executes the completion block when done.
1675-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
1675+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
16761676
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
16771677
Defaults to 50.
16781678
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that

‎Sources/ParseSwift/Objects/ParseObject+async.swift‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ public extension Sequence where Element: ParseObject {
129129

130130
/**
131131
Saves a collection of objects *asynchronously*.
132-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
132+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
133133
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
134134
Defaults to 50.
135135
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -171,7 +171,7 @@ public extension Sequence where Element: ParseObject {
171171

172172
/**
173173
Creates a collection of objects *asynchronously*.
174-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
174+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
175175
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
176176
Defaults to 50.
177177
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -199,7 +199,7 @@ public extension Sequence where Element: ParseObject {
199199

200200
/**
201201
Replaces a collection of objects *asynchronously*.
202-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
202+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
203203
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
204204
Defaults to 50.
205205
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -227,7 +227,7 @@ public extension Sequence where Element: ParseObject {
227227

228228
/**
229229
Updates a collection of objects *asynchronously*.
230-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
230+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
231231
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
232232
Defaults to 50.
233233
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -255,7 +255,7 @@ public extension Sequence where Element: ParseObject {
255255

256256
/**
257257
Deletes a collection of objects *asynchronously*.
258-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
258+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
259259
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
260260
Defaults to 50.
261261
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that

‎Sources/ParseSwift/Objects/ParseObject+combine.swift‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ public extension Sequence where Element: ParseObject {
135135

136136
/**
137137
Saves a collection of objects *asynchronously* and publishes when complete.
138-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
138+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
139139
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
140140
Defaults to 50.
141141
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -174,7 +174,7 @@ public extension Sequence where Element: ParseObject {
174174

175175
/**
176176
Creates a collection of objects *asynchronously* and publishes when complete.
177-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
177+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
178178
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
179179
Defaults to 50.
180180
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -199,7 +199,7 @@ public extension Sequence where Element: ParseObject {
199199

200200
/**
201201
Replaces a collection of objects *asynchronously* and publishes when complete.
202-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
202+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
203203
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
204204
Defaults to 50.
205205
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -224,7 +224,7 @@ public extension Sequence where Element: ParseObject {
224224

225225
/**
226226
Updates a collection of objects *asynchronously* and publishes when complete.
227-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
227+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
228228
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
229229
Defaults to 50.
230230
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that
@@ -250,7 +250,7 @@ public extension Sequence where Element: ParseObject {
250250

251251
/**
252252
Deletes a collection of objects *asynchronously* and publishes when complete.
253-
- parameter batchLimit: The maximum number of objects to send in each batch. If the items to be batched.
253+
- parameter batchLimit: The maximum number of objects to send in each batch. If the amount of items to be batched
254254
is greater than the `batchLimit`, the objects will be sent to the server in waves up to the `batchLimit`.
255255
Defaults to 50.
256256
- parameter transaction: Treat as an all-or-nothing operation. If some operation failure occurs that

0 commit comments

Comments
 (0)