Skip to content

Commit c6d7af5

Browse files
committed
More method comments.
1 parent 905b0b0 commit c6d7af5

File tree

2 files changed

+30
-9
lines changed

2 files changed

+30
-9
lines changed

Sources/DiffableTextKitXPattern/Style.swift

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,17 @@ Value: RangeReplaceableCollection, Value.Element == Character {
3434
// MARK: Transformations
3535
//=------------------------------------------------------------------------=
3636

37-
@inlinable public func placeholders(_ placeholders: [Character: (Character) -> Bool]) -> Self {
38-
var S0 = self; S0.placeholders = .init(placeholders); return S0
39-
}
40-
37+
/// Marks a single character as a placeholder.
4138
@inlinable public func placeholders(_ character: Character,
4239
where predicate: @escaping (Character) -> Bool) -> Self {
4340
var S0 = self; S0.placeholders = .init((character, predicate)); return S0
4441
}
4542

43+
/// Marks multiple characters as placeholders.
44+
@inlinable public func placeholders(_ placeholders: [Character: (Character) -> Bool]) -> Self {
45+
var S0 = self; S0.placeholders = .init(placeholders); return S0
46+
}
47+
4648
//=------------------------------------------------------------------------=
4749
// MARK: Transformations
4850
//=------------------------------------------------------------------------=
@@ -249,17 +251,37 @@ extension PatternTextStyle {
249251
// MARK: * Style x Init
250252
//*============================================================================*
251253
//=----------------------------------------------------------------------------=
252-
// MARK: + String [...]
254+
// MARK: + String
253255
//=----------------------------------------------------------------------------=
254256

255257
extension DiffableTextStyle where Self == PatternTextStyle<String> {
258+
259+
/// Creates a `PatternTextStyle` without placeholders.
260+
///
261+
/// ```
262+
/// DiffableTextField(value: $number) {
263+
/// .pattern("+## (###) ###-##-##")
264+
/// .placeholders("#") { $0.isASCII && $0.isNumber }
265+
/// }
266+
/// ```
267+
///
256268
@inlinable public static func pattern(_ pattern: String) -> Self { Self(pattern) }
257269
}
258270

259271
//=----------------------------------------------------------------------------=
260-
// MARK: + Array<Character> [...]
272+
// MARK: + Array<Character>
261273
//=----------------------------------------------------------------------------=
262274

263275
extension DiffableTextStyle where Self == PatternTextStyle<[Character]> {
276+
277+
/// Creates a `PatternTextStyle` without placeholders.
278+
///
279+
/// ```
280+
/// DiffableTextField(value: $number) {
281+
/// .pattern("+## (###) ###-##-##")
282+
/// .placeholders("#") { $0.isASCII && $0.isNumber }
283+
/// }
284+
/// ```
285+
///
264286
@inlinable public static func pattern(_ pattern: String) -> Self { Self(pattern) }
265287
}

Sources/DiffableTextKitXUIKit/Environment+OnSubmit.swift

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,8 @@ public extension View {
3535
///
3636
/// ```
3737
/// DiffableTextField("Username", text: $username, style: .normal)
38-
/// .onSubmit {
39-
/// guard model.validate() else { return }
40-
/// model.login()
38+
/// .diffableTextViews_onSubmit {
39+
/// print("Validate and try to login with \(username)...")
4140
/// }
4241
/// ```
4342
///

0 commit comments

Comments
 (0)