-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Rename Start() to Run() since it's a blocking call #615
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Start
really gives the impression that it won't wait for the app to exit (see components Start
methods). Since the break (when Start is removed) is trivial I'm for it.
// given by the user. | ||
// given by the user, and waits for it to complete. | ||
// | ||
// Deprecated: use Run instead. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a breaking change of an exported public function. The improvement is not worth it.
Ignore this, I misunderstood the change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
However, I still think it is not worth it. We end up with 2 functions. It is even more confusing than just using the name Start instead of Run.
I think it's worth it given the minimal impact it'll have now vs confusion it might create a year later. I'd even go as far as returning an error from |
I am going to close this as "won't accept" unless someone has arguments which I am missing. This change adds an duplicate function that does the same thing as another existing function. What's the end game? Are we keeping both? If we intend to retire one it means more work needs to be done, we need to announce a breaking change and fix contrib that relies on Start. I think these all is not worth the time everyone has to spend on it. @nilebox your contributions are highly welcome and I believe you are already contributing much higher value PRs by doing the OTLP implementation. I hope you don't mind if I block low ROI items like this, happy to discuss further to explain my position if it is not clear. |
Closing since I don't see objections. We can reopen if needed. |
As someone who has spent significant time to rebase our internal code on |
Rename Start() to Run() to follow the naming pattern used in Go, e.g. see blocking Cmd.Run vs non-blocking Cmd.Start.
Same as #607 but keeping original method for backward compatibility. We can keep it for a few releases before deleting.