appwrite / sdk-for-dotnet

[READ-ONLY] Official Appwrite .NET SDK
https://appwrite.io
BSD 3-Clause "New" or "Revised" License
110 stars 20 forks source link

C#/.Net naming conventions for async/await methods #41

Open Atteprojects opened 5 months ago

Atteprojects commented 5 months ago

🔖 Feature description

The following link has the naming conventions for async/await methods in c#/.Net from Microsoft and the method names in the Appwrite .Net SDk should follow the same pattern. For example, the method to create a user should be CreateAsync() and not just Create().

https://learn.microsoft.com/en-us/dotnet/csharp/asynchronous-programming/async-scenarios#important-info-and-advice

🎤 Pitch

This should be implemented to make the Appwrite SDK consistent with Microsoft's recommended naming conventions for async/await methods.

Related thread: https://discord.com/channels/564160730845151244/1247715993460146256

👀 Have you spent some time to check if this issue has been raised before?

🏢 Have you read the Code of Conduct?

stnguyen90 commented 5 months ago

@Atteprojects, thanks for raising this issue! 🙏🏼 I've talked with the team and we've decided to not add the Async suffix to keep things simple and aligned with our other SDKs. The convention says:

This is the convention used in .NET to more easily differentiate synchronous and asynchronous methods.

but since all of our methods are Async and we don't have synchronous methods, the suffix would just add clutter.