Skip to content

Commit a74b5b7

Browse files
committed
[stdlib] make parameter label the same as in peer functions
These functions were the odd ones out in not using `encoding` for this parameter label. Harmonizing this term will also make the documentation more consistent.
1 parent 048a948 commit a74b5b7

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

stdlib/public/core/CString.swift

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -460,17 +460,17 @@ extension String {
460460
///
461461
/// - Parameters:
462462
/// - nullTerminatedCodeUnits: A pointer to a null-terminated sequence of
463-
/// code units encoded in `sourceEncoding`.
464-
/// - sourceEncoding: The encoding in which the code units should be
463+
/// code units encoded in `encoding`.
464+
/// - encoding: The encoding in which the code units should be
465465
/// interpreted.
466466
@_specialize(where Encoding == Unicode.UTF8)
467467
@_specialize(where Encoding == Unicode.UTF16)
468468
@inlinable // Fold away specializations
469469
public init<Encoding: Unicode.Encoding>(
470470
decodingCString nullTerminatedCodeUnits: UnsafePointer<Encoding.CodeUnit>,
471-
as sourceEncoding: Encoding.Type
471+
as encoding: Encoding.Type
472472
) {
473-
self = String.decodeCString(nullTerminatedCodeUnits, as: sourceEncoding)!.0
473+
self = String.decodeCString(nullTerminatedCodeUnits, as: encoding)!.0
474474
}
475475

476476
/// Creates a new string by copying the null-terminated sequence of code units
@@ -486,28 +486,28 @@ extension String {
486486
///
487487
/// - Parameters:
488488
/// - nullTerminatedCodeUnits: An array containing a null-terminated
489-
/// sequence of code units encoded in `sourceEncoding`.
490-
/// - sourceEncoding: The encoding in which the code units should be
489+
/// sequence of code units encoded in `encoding`.
490+
/// - encoding: The encoding in which the code units should be
491491
/// interpreted.
492492
@inlinable
493493
@_alwaysEmitIntoClient
494494
@available(swift, deprecated: 6, message: "Use String(decoding: array, as: Encoding.self) instead")
495495
public init<Encoding: Unicode.Encoding>(
496496
decodingCString nullTerminatedCodeUnits: [Encoding.CodeUnit],
497-
as sourceEncoding: Encoding.Type
497+
as encoding: Encoding.Type
498498
) {
499-
self = String.decodeCString(nullTerminatedCodeUnits, as: sourceEncoding)!.0
499+
self = String.decodeCString(nullTerminatedCodeUnits, as: encoding)!.0
500500
}
501501

502502
@inlinable
503503
@_alwaysEmitIntoClient
504504
@available(*, deprecated, message: "Use a copy of the String argument")
505505
public init<Encoding: _UnicodeEncoding>(
506506
decodingCString nullTerminatedCodeUnits: String,
507-
as sourceEncoding: Encoding.Type
507+
as encoding: Encoding.Type
508508
) {
509-
self = nullTerminatedCodeUnits.withCString(encodedAs: sourceEncoding) {
510-
String(decodingCString: $0, as: sourceEncoding.self)
509+
self = nullTerminatedCodeUnits.withCString(encodedAs: encoding) {
510+
String(decodingCString: $0, as: encoding.self)
511511
}
512512
}
513513

@@ -516,7 +516,7 @@ extension String {
516516
@available(*, deprecated, message: "Use String(_ scalar: Unicode.Scalar)")
517517
public init<Encoding: Unicode.Encoding>(
518518
decodingCString nullTerminatedCodeUnits: inout Encoding.CodeUnit,
519-
as sourceEncoding: Encoding.Type
519+
as encoding: Encoding.Type
520520
) {
521521
guard nullTerminatedCodeUnits == 0 else {
522522
_preconditionFailure(

0 commit comments

Comments
 (0)