-
Notifications
You must be signed in to change notification settings - Fork 234
Update all async API methods to use "Async" suffix #177
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
Comments
I think async methods should be suffixed with Async. The Microsoft prescribed guidance is:
From https://msdn.microsoft.com/en-us/library/hh191443.aspx. I see Stephen Cleary using the convention consistently in the "Concurrency in C# Cookbook". Yep, been reading through it. Thanks for the recommend. :-) |
It's a good book! Alright, we'll use *Async. It'd definitely eliminate confusion about which methods should be called with await. Any new async methods you add in the meantime, feel free to use the Async suffix. |
Will do. |
Is this still planned? I don't mind doing it. Should the PR be against the 2.0.0 branch? |
It's on the backlog for sure - no one's actively working on it AFAIK. Against 2.0.0 is probably the right approach! |
Ok I'll pick this one up then if it's up for grabs for anyone. Should a method that returns a |
If it returns a task, then the function is expecting it to be awaited so I say add it. |
In our work to clean up the API for a stable 1.0 release later this year, we'll need to decide whether we want to use the "Async" suffix on any async methods so that their usage is clear. I personally don't like the suffix but I can understand why it's useful. I wonder if the general guidelines for the usage of this suffix will go away as more and more .NET API methods become async.
Thoughts?
The text was updated successfully, but these errors were encountered: