Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SR-9330] DispatchSourceTimer schedule methods should document the default values #631

Open
lilyball mannequin opened this issue Nov 23, 2018 · 2 comments
Open

[SR-9330] DispatchSourceTimer schedule methods should document the default values #631

lilyball mannequin opened this issue Nov 23, 2018 · 2 comments

Comments

@lilyball
Copy link
Mannequin

@lilyball lilyball mannequin commented Nov 23, 2018

Previous ID SR-9330
Radar None
Original Reporter @lilyball
Type Bug
Environment

Apple Swift version 4.2.1 (swiftlang-1000.11.42 clang-1000.11.45.1)
Target: x86_64-apple-darwin18.2.0

Additional Detail from JIRA
Votes 0
Component/s libdispatch
Labels Bug
Assignee None
Priority Medium

md5: 546cc724bb4b9cdcd1d433f0fec20a84

Issue Description:

The DispatchSourceTimer suite of schedule methods all have documentation comments, but the documentation comments don't explain what the default values for parameters are. So for example, the schedule(deadline:repeating:leeway🙂 method does not make it clear whether omitting the repeating: argument will produce a oneshot timer or not. Of course, in this instance if it produced a repeating timer there's no obvious value for what the repeating interval would be, but still, any time I use this method I always have to double-check what the default value is in the source in order to satisfy myself that I really am producing a oneshot timer.

@belkadan
Copy link

@belkadan belkadan commented Nov 26, 2018

cc phabouzit (JIRA User), @natecook1000

@swift-ci
Copy link

@swift-ci swift-ci commented Nov 29, 2018

Comment by Matt Wright (JIRA)

cc ktopley-apple (JIRA User)

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from apple/swift May 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants