Skip to content

Commit 4965e35

Browse files
committed
Tweak documentation
1 parent 98fe073 commit 4965e35

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Src/SwiftyTimer.swift

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,11 @@ private class NSTimerActor {
3737
}
3838

3939
extension NSTimer {
40-
// NOTE: `new` class functions are a workaround for a crashing bug when using convenience initializers (18720947)
41-
4240
/// Create a timer that will call `block` once after the specified time.
4341
///
44-
/// **Note:** the timer won't fire until it's scheduled on the run loop.
45-
/// Use `NSTimer.after` to create and schedule a timer in one step.
42+
/// - Note: The timer won't fire until it's scheduled on the run loop.
43+
/// Use `NSTimer.after` to create and schedule a timer in one step.
44+
/// - Note: The `new` class function is a workaround for a crashing bug when using convenience initializers (rdar://18720947)
4645

4746
public class func new(after interval: NSTimeInterval, _ block: () -> Void) -> NSTimer {
4847
let actor = NSTimerActor(block)
@@ -51,8 +50,9 @@ extension NSTimer {
5150

5251
/// Create a timer that will call `block` repeatedly in specified time intervals.
5352
///
54-
/// **Note:** the timer won't fire until it's scheduled on the run loop.
55-
/// Use `NSTimer.every` to create and schedule a timer in one step.
53+
/// - Note: The timer won't fire until it's scheduled on the run loop.
54+
/// Use `NSTimer.after` to create and schedule a timer in one step.
55+
/// - Note: The `new` class function is a workaround for a crashing bug when using convenience initializers (rdar://18720947)
5656

5757
public class func new(every interval: NSTimeInterval, _ block: () -> Void) -> NSTimer {
5858
let actor = NSTimerActor(block)

0 commit comments

Comments
 (0)