diff --git a/_rules/1755.md b/_rules/1755.md index af721d61..74a326aa 100644 --- a/_rules/1755.md +++ b/_rules/1755.md @@ -1,7 +1,7 @@ --- rule_id: 1755 rule_category: naming-conventions -title: Postfix asynchronous methods with `Async` or `TaskAsync` +title: Only use `Async` or `TaskAsync` as a suffix when a method has both synchronous and asynchronous versions severity: 2 --- -The general convention for methods and local functions that return `Task` or `Task` is to postfix them with `Async`. But if such a method already exists, use `TaskAsync` instead. +Only suffix a method or local function that returns `Task` or `Task` with `Async` if there is also a synchronous variant of that method. If no synchronous variant exists, the `Async` suffix adds unnecessary noise. If both synchronous and asynchronous variants exist, use `Async` as the suffix. If a method suffixed with `Async` already exists, use `TaskAsync` instead.