Skip to content

Commit f188bff

Browse files
committed
[doc] Avoid use of “iff” in public API documentation
1 parent e3623cc commit f188bff

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

Darwin/Foundation-swiftoverlay/Decimal.swift

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -538,31 +538,33 @@ extension Decimal {
538538

539539
public var isCanonical: Bool { true }
540540

541-
/// `true` iff `self` is negative.
541+
/// `true` if `self` is negative, `false` otherwise.
542542
public var isSignMinus: Bool { _isNegative != 0 }
543543

544-
/// `true` iff `self` is +0.0 or -0.0.
544+
/// `true` if `self` is +0.0 or -0.0, `false` otherwise.
545545
public var isZero: Bool { _length == 0 && _isNegative == 0 }
546546

547-
/// `true` iff `self` is subnormal.
547+
/// `true` if `self` is subnormal, `false` otherwise.
548548
public var isSubnormal: Bool { false }
549549

550-
/// `true` iff `self` is normal (not zero, subnormal, infinity, or NaN).
550+
/// `true` if `self` is normal (not zero, subnormal, infinity, or NaN),
551+
/// `false` otherwise.
551552
public var isNormal: Bool { !isZero && !isInfinite && !isNaN }
552553

553-
/// `true` iff `self` is zero, subnormal, or normal (not infinity or NaN).
554+
/// `true` if `self` is zero, subnormal, or normal (not infinity or NaN),
555+
/// `false` otherwise.
554556
public var isFinite: Bool { !isNaN }
555557

556-
/// `true` iff `self` is infinity.
558+
/// `true` if `self` is infinity, `false` otherwise.
557559
public var isInfinite: Bool { false }
558560

559-
/// `true` iff `self` is NaN.
561+
/// `true` if `self` is NaN, `false` otherwise.
560562
public var isNaN: Bool { _length == 0 && _isNegative == 1 }
561563

562-
/// `true` iff `self` is a signaling NaN.
564+
/// `true` if `self` is a signaling NaN, `false` otherwise.
563565
public var isSignaling: Bool { false }
564566

565-
/// `true` iff `self` is a signaling NaN.
567+
/// `true` if `self` is a signaling NaN, `false` otherwise.
566568
public var isSignalingNaN: Bool { false }
567569

568570
public func isEqual(to other: Decimal) -> Bool {

Darwin/Foundation-swiftoverlay/NSStringAPI.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1368,7 +1368,7 @@ extension StringProtocol where Index == String.Index {
13681368
/// - Parameter leftover: The remaining range. Pass `nil` If you do
13691369
/// not need this value.
13701370
///
1371-
/// - Returns: `true` iff some characters were converted.
1371+
/// - Returns: `true` if some characters were converted, `false` otherwise.
13721372
///
13731373
/// - Note: Conversion stops when the buffer fills or when the
13741374
/// conversion isn't possible due to the chosen encoding.
@@ -1668,8 +1668,8 @@ extension StringProtocol where Index == String.Index {
16681668
// No need to make these unavailable on earlier OSes, since they can
16691669
// forward trivially to rangeOfString.
16701670

1671-
/// Returns `true` iff `other` is non-empty and contained within
1672-
/// `self` by case-sensitive, non-literal search.
1671+
/// Returns `true` if `other` is non-empty and contained within `self` by
1672+
/// case-sensitive, non-literal search. Otherwise, returns `false`.
16731673
///
16741674
/// Equivalent to `self.rangeOfString(other) != nil`
16751675
public func contains<T : StringProtocol>(_ other: T) -> Bool {

0 commit comments

Comments
 (0)