Skip to content

Commit c3cbbd3

Browse files
kevinrenskerskevinrenskers
committed
chore: Fix order of parameters
1 parent 65b8f6b commit c3cbbd3

File tree

5 files changed

+103
-103
lines changed

5 files changed

+103
-103
lines changed

‎Sources/Saga/Saga.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@ public class Saga {
6666
/// - folder: The folder (relative to `input`) to operate on. If `nil`, it operates on the `input` folder itself.
6767
/// - metadata: The metadata type used for the processing step. You can use ``EmptyMetadata`` if you don't need any custom metadata (which is the default value).
6868
/// - readers: The readers that will be used by this step.
69-
/// - itemWriteMode: The ``ItemWriteMode`` used by this step.
7069
/// - itemProcessor: A function to modify the generated ``Item`` as you see fit.
7170
/// - filter: A filter to only include certain items from the input folder.
71+
/// - itemWriteMode: The ``ItemWriteMode`` used by this step.
7272
/// - writers: The writers that will be used by this step.
7373
/// - Returns: The Saga instance itself, so you can chain further calls onto it.
7474
@discardableResult
75-
public func register<M: Metadata>(folder: Path? = nil, metadata: M.Type = EmptyMetadata.self, readers: [Reader<M>], itemWriteMode: ItemWriteMode = .moveToSubfolder, itemProcessor: ((Item<M>) async -> Void)? = nil, filter: @escaping ((Item<M>) -> Bool) = { _ in true }, writers: [Writer<M>]) throws -> Self {
75+
public func register<M: Metadata>(folder: Path? = nil, metadata: M.Type = EmptyMetadata.self, readers: [Reader<M>], itemProcessor: ((Item<M>) async -> Void)? = nil, filter: @escaping ((Item<M>) -> Bool) = { _ in true }, itemWriteMode: ItemWriteMode = .moveToSubfolder, writers: [Writer<M>]) throws -> Self {
7676
let step = ProcessStep(folder: folder, readers: readers, itemProcessor: itemProcessor, filter: filter, writers: writers)
7777
self.processSteps.append(
7878
.init(

‎docs/data/documentation/saga/saga.json

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@
148148
"anchor" : "Instance-Methods",
149149
"generated" : true,
150150
"identifiers" : [
151-
"doc:\/\/Saga\/documentation\/Saga\/Saga\/register(folder:metadata:readers:itemWriteMode:itemProcessor:filter:writers:)",
151+
"doc:\/\/Saga\/documentation\/Saga\/Saga\/register(folder:metadata:readers:itemProcessor:filter:itemWriteMode:writers:)",
152152
"doc:\/\/Saga\/documentation\/Saga\/Saga\/run()",
153153
"doc:\/\/Saga\/documentation\/Saga\/Saga\/staticFiles()"
154154
],
@@ -441,7 +441,7 @@
441441
"type" : "topic",
442442
"url" : "\/documentation\/saga\/saga\/outputpath"
443443
},
444-
"doc://Saga/documentation/Saga/Saga/register(folder:metadata:readers:itemWriteMode:itemProcessor:filter:writers:)": {
444+
"doc://Saga/documentation/Saga/Saga/register(folder:metadata:readers:itemProcessor:filter:itemWriteMode:writers:)": {
445445
"abstract" : [
446446
{
447447
"text" : "Register a new processing step.",
@@ -531,23 +531,6 @@
531531
"kind" : "text",
532532
"text" : ">], "
533533
},
534-
{
535-
"kind" : "externalParam",
536-
"text" : "itemWriteMode"
537-
},
538-
{
539-
"kind" : "text",
540-
"text" : ": "
541-
},
542-
{
543-
"kind" : "typeIdentifier",
544-
"preciseIdentifier" : "s:4Saga13ItemWriteModeO",
545-
"text" : "ItemWriteMode"
546-
},
547-
{
548-
"kind" : "text",
549-
"text" : ", "
550-
},
551534
{
552535
"kind" : "externalParam",
553536
"text" : "itemProcessor"
@@ -624,6 +607,23 @@
624607
"kind" : "text",
625608
"text" : "), "
626609
},
610+
{
611+
"kind" : "externalParam",
612+
"text" : "itemWriteMode"
613+
},
614+
{
615+
"kind" : "text",
616+
"text" : ": "
617+
},
618+
{
619+
"kind" : "typeIdentifier",
620+
"preciseIdentifier" : "s:4Saga13ItemWriteModeO",
621+
"text" : "ItemWriteMode"
622+
},
623+
{
624+
"kind" : "text",
625+
"text" : ", "
626+
},
627627
{
628628
"kind" : "externalParam",
629629
"text" : "writers"
@@ -662,12 +662,12 @@
662662
"text" : "Self"
663663
}
664664
],
665-
"identifier" : "doc:\/\/Saga\/documentation\/Saga\/Saga\/register(folder:metadata:readers:itemWriteMode:itemProcessor:filter:writers:)",
665+
"identifier" : "doc:\/\/Saga\/documentation\/Saga\/Saga\/register(folder:metadata:readers:itemProcessor:filter:itemWriteMode:writers:)",
666666
"kind" : "symbol",
667667
"role" : "symbol",
668-
"title" : "register(folder:metadata:readers:itemWriteMode:itemProcessor:filter:writers:)",
668+
"title" : "register(folder:metadata:readers:itemProcessor:filter:itemWriteMode:writers:)",
669669
"type" : "topic",
670-
"url" : "\/documentation\/saga\/saga\/register(folder:metadata:readers:itemwritemode:itemprocessor:filter:writers:)"
670+
"url" : "\/documentation\/saga\/saga\/register(folder:metadata:readers:itemprocessor:filter:itemwritemode:writers:)"
671671
},
672672
"doc://Saga/documentation/Saga/Saga/rootPath": {
673673
"abstract" : [

‎docs/data/documentation/saga/saga/register(folder:metadata:readers:itemwritemode:itemprocessor:filter:writers:).json renamed to ‎docs/data/documentation/saga/saga/register(folder:metadata:readers:itemprocessor:filter:itemwritemode:writers:).json

Lines changed: 77 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515
},
1616
"identifier" : {
1717
"interfaceLanguage" : "swift",
18-
"url" : "doc:\/\/Saga\/documentation\/Saga\/Saga\/register(folder:metadata:readers:itemWriteMode:itemProcessor:filter:writers:)"
18+
"url" : "doc:\/\/Saga\/documentation\/Saga\/Saga\/register(folder:metadata:readers:itemProcessor:filter:itemWriteMode:writers:)"
1919
},
2020
"kind" : "symbol",
2121
"metadata" : {
22-
"externalID" : "s:4SagaAAC8register6folder8metadata7readers13itemWriteMode0F9Processor6filter7writersABXD7PathKit0L0VSg_xmSayAA6ReaderVyxGGAA04ItemgH0OyAA0O0CyxGYacSgSbAWcSayAA6WriterVyxGGtKAA8MetadataRzlF",
22+
"externalID" : "s:4SagaAAC8register6folder8metadata7readers13itemProcessor6filter0F9WriteMode7writersABXD7PathKit0L0VSg_xmSayAA6ReaderVyxGGyAA4ItemCyxGYacSgSbAUcAA0oiJ0OSayAA6WriterVyxGGtKAA8MetadataRzlF",
2323
"fragments" : [
2424
{
2525
"kind" : "keyword",
@@ -103,23 +103,6 @@
103103
"kind" : "text",
104104
"text" : ">], "
105105
},
106-
{
107-
"kind" : "externalParam",
108-
"text" : "itemWriteMode"
109-
},
110-
{
111-
"kind" : "text",
112-
"text" : ": "
113-
},
114-
{
115-
"kind" : "typeIdentifier",
116-
"preciseIdentifier" : "s:4Saga13ItemWriteModeO",
117-
"text" : "ItemWriteMode"
118-
},
119-
{
120-
"kind" : "text",
121-
"text" : ", "
122-
},
123106
{
124107
"kind" : "externalParam",
125108
"text" : "itemProcessor"
@@ -196,6 +179,23 @@
196179
"kind" : "text",
197180
"text" : "), "
198181
},
182+
{
183+
"kind" : "externalParam",
184+
"text" : "itemWriteMode"
185+
},
186+
{
187+
"kind" : "text",
188+
"text" : ": "
189+
},
190+
{
191+
"kind" : "typeIdentifier",
192+
"preciseIdentifier" : "s:4Saga13ItemWriteModeO",
193+
"text" : "ItemWriteMode"
194+
},
195+
{
196+
"kind" : "text",
197+
"text" : ", "
198+
},
199199
{
200200
"kind" : "externalParam",
201201
"text" : "writers"
@@ -242,7 +242,7 @@
242242
"role" : "symbol",
243243
"roleHeading" : "Instance Method",
244244
"symbolKind" : "method",
245-
"title" : "register(folder:metadata:readers:itemWriteMode:itemProcessor:filter:writers:)"
245+
"title" : "register(folder:metadata:readers:itemProcessor:filter:itemWriteMode:writers:)"
246246
},
247247
"primaryContentSections" : [
248248
{
@@ -346,24 +346,6 @@
346346
"kind" : "text",
347347
"text" : ">], "
348348
},
349-
{
350-
"kind" : "externalParam",
351-
"text" : "itemWriteMode"
352-
},
353-
{
354-
"kind" : "text",
355-
"text" : ": "
356-
},
357-
{
358-
"identifier" : "doc:\/\/Saga\/documentation\/Saga\/ItemWriteMode",
359-
"kind" : "typeIdentifier",
360-
"preciseIdentifier" : "s:4Saga13ItemWriteModeO",
361-
"text" : "ItemWriteMode"
362-
},
363-
{
364-
"kind" : "text",
365-
"text" : " = .moveToSubfolder, "
366-
},
367349
{
368350
"kind" : "externalParam",
369351
"text" : "itemProcessor"
@@ -450,6 +432,24 @@
450432
"kind" : "text",
451433
"text" : ") = { _ in true }, "
452434
},
435+
{
436+
"kind" : "externalParam",
437+
"text" : "itemWriteMode"
438+
},
439+
{
440+
"kind" : "text",
441+
"text" : ": "
442+
},
443+
{
444+
"identifier" : "doc:\/\/Saga\/documentation\/Saga\/ItemWriteMode",
445+
"kind" : "typeIdentifier",
446+
"preciseIdentifier" : "s:4Saga13ItemWriteModeO",
447+
"text" : "ItemWriteMode"
448+
},
449+
{
450+
"kind" : "text",
451+
"text" : " = .moveToSubfolder, "
452+
},
453453
{
454454
"kind" : "externalParam",
455455
"text" : "writers"
@@ -602,60 +602,60 @@
602602
{
603603
"inlineContent" : [
604604
{
605-
"text" : "The ",
605+
"text" : "A function to modify the generated ",
606606
"type" : "text"
607607
},
608608
{
609-
"identifier" : "doc:\/\/Saga\/documentation\/Saga\/ItemWriteMode",
609+
"identifier" : "doc:\/\/Saga\/documentation\/Saga\/Item",
610610
"isActive" : true,
611611
"type" : "reference"
612612
},
613613
{
614-
"text" : " used by this step.",
614+
"text" : " as you see fit.",
615615
"type" : "text"
616616
}
617617
],
618618
"type" : "paragraph"
619619
}
620620
],
621-
"name" : "itemWriteMode"
621+
"name" : "itemProcessor"
622622
},
623623
{
624624
"content" : [
625625
{
626626
"inlineContent" : [
627627
{
628-
"text" : "A function to modify the generated ",
629-
"type" : "text"
630-
},
631-
{
632-
"identifier" : "doc:\/\/Saga\/documentation\/Saga\/Item",
633-
"isActive" : true,
634-
"type" : "reference"
635-
},
636-
{
637-
"text" : " as you see fit.",
628+
"text" : "A filter to only include certain items from the input folder.",
638629
"type" : "text"
639630
}
640631
],
641632
"type" : "paragraph"
642633
}
643634
],
644-
"name" : "itemProcessor"
635+
"name" : "filter"
645636
},
646637
{
647638
"content" : [
648639
{
649640
"inlineContent" : [
650641
{
651-
"text" : "A filter to only include certain items from the input folder.",
642+
"text" : "The ",
643+
"type" : "text"
644+
},
645+
{
646+
"identifier" : "doc:\/\/Saga\/documentation\/Saga\/ItemWriteMode",
647+
"isActive" : true,
648+
"type" : "reference"
649+
},
650+
{
651+
"text" : " used by this step.",
652652
"type" : "text"
653653
}
654654
],
655655
"type" : "paragraph"
656656
}
657657
],
658-
"name" : "filter"
658+
"name" : "itemWriteMode"
659659
},
660660
{
661661
"content" : [
@@ -705,7 +705,7 @@
705705
"variants" : [
706706
{
707707
"paths" : [
708-
"\/documentation\/saga\/saga\/register(folder:metadata:readers:itemwritemode:itemprocessor:filter:writers:)"
708+
"\/documentation\/saga\/saga\/register(folder:metadata:readers:itemprocessor:filter:itemwritemode:writers:)"
709709
],
710710
"traits" : [
711711
{
@@ -949,7 +949,7 @@
949949
"type" : "topic",
950950
"url" : "\/documentation\/saga\/saga"
951951
},
952-
"doc://Saga/documentation/Saga/Saga/register(folder:metadata:readers:itemWriteMode:itemProcessor:filter:writers:)": {
952+
"doc://Saga/documentation/Saga/Saga/register(folder:metadata:readers:itemProcessor:filter:itemWriteMode:writers:)": {
953953
"abstract" : [
954954
{
955955
"text" : "Register a new processing step.",
@@ -1039,23 +1039,6 @@
10391039
"kind" : "text",
10401040
"text" : ">], "
10411041
},
1042-
{
1043-
"kind" : "externalParam",
1044-
"text" : "itemWriteMode"
1045-
},
1046-
{
1047-
"kind" : "text",
1048-
"text" : ": "
1049-
},
1050-
{
1051-
"kind" : "typeIdentifier",
1052-
"preciseIdentifier" : "s:4Saga13ItemWriteModeO",
1053-
"text" : "ItemWriteMode"
1054-
},
1055-
{
1056-
"kind" : "text",
1057-
"text" : ", "
1058-
},
10591042
{
10601043
"kind" : "externalParam",
10611044
"text" : "itemProcessor"
@@ -1132,6 +1115,23 @@
11321115
"kind" : "text",
11331116
"text" : "), "
11341117
},
1118+
{
1119+
"kind" : "externalParam",
1120+
"text" : "itemWriteMode"
1121+
},
1122+
{
1123+
"kind" : "text",
1124+
"text" : ": "
1125+
},
1126+
{
1127+
"kind" : "typeIdentifier",
1128+
"preciseIdentifier" : "s:4Saga13ItemWriteModeO",
1129+
"text" : "ItemWriteMode"
1130+
},
1131+
{
1132+
"kind" : "text",
1133+
"text" : ", "
1134+
},
11351135
{
11361136
"kind" : "externalParam",
11371137
"text" : "writers"
@@ -1170,12 +1170,12 @@
11701170
"text" : "Self"
11711171
}
11721172
],
1173-
"identifier" : "doc:\/\/Saga\/documentation\/Saga\/Saga\/register(folder:metadata:readers:itemWriteMode:itemProcessor:filter:writers:)",
1173+
"identifier" : "doc:\/\/Saga\/documentation\/Saga\/Saga\/register(folder:metadata:readers:itemProcessor:filter:itemWriteMode:writers:)",
11741174
"kind" : "symbol",
11751175
"role" : "symbol",
1176-
"title" : "register(folder:metadata:readers:itemWriteMode:itemProcessor:filter:writers:)",
1176+
"title" : "register(folder:metadata:readers:itemProcessor:filter:itemWriteMode:writers:)",
11771177
"type" : "topic",
1178-
"url" : "\/documentation\/saga\/saga\/register(folder:metadata:readers:itemwritemode:itemprocessor:filter:writers:)"
1178+
"url" : "\/documentation\/saga\/saga\/register(folder:metadata:readers:itemprocessor:filter:itemwritemode:writers:)"
11791179
},
11801180
"doc://Saga/documentation/Saga/Writer": {
11811181
"abstract" : [

‎docs/documentation/saga/saga/register(folder:metadata:readers:itemwritemode:itemprocessor:filter:writers:)/index.html renamed to ‎docs/documentation/saga/saga/register(folder:metadata:readers:itemprocessor:filter:itemwritemode:writers:)/index.html

File renamed without changes.

‎docs/index/index.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,8 +344,8 @@
344344
"type" : "groupMarker"
345345
},
346346
{
347-
"path" : "\/documentation\/saga\/saga\/register(folder:metadata:readers:itemwritemode:itemprocessor:filter:writers:)",
348-
"title" : "func register<M>(folder: Path?, metadata: M.Type, readers: [Reader<M>], itemWriteMode: ItemWriteMode, itemProcessor: ((Item<M>) async -> Void)?, filter: ((Item<M>) -> Bool), writers: [Writer<M>]) throws -> Self",
347+
"path" : "\/documentation\/saga\/saga\/register(folder:metadata:readers:itemprocessor:filter:itemwritemode:writers:)",
348+
"title" : "func register<M>(folder: Path?, metadata: M.Type, readers: [Reader<M>], itemProcessor: ((Item<M>) async -> Void)?, filter: ((Item<M>) -> Bool), itemWriteMode: ItemWriteMode, writers: [Writer<M>]) throws -> Self",
349349
"type" : "method"
350350
},
351351
{

0 commit comments

Comments
 (0)