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

Code Quality: Append Async to the end of each async method for consistency #12310

Closed
itsWindows11 opened this issue May 9, 2023 · 6 comments · Fixed by #13533
Closed

Code Quality: Append Async to the end of each async method for consistency #12310

itsWindows11 opened this issue May 9, 2023 · 6 comments · Fixed by #13533

Comments

@itsWindows11
Copy link
Contributor

itsWindows11 commented May 9, 2023

Description

Some of the methods in the codebase have Async in the end of the method name for the async task, but most async methods in the entire solution don't end with Async, for example ArchiveHelpers.DecompressArchiveHere.

Concerned code

The entire solution.

Gains

  • Better consistency between async method namings.
  • Quickly identify async methods that might not be awaited in the codebase.

Requirements

  • Append Async to all the async method names, i.e. instead of public Task Do(), rename to public Task DoAsync().
  • For async void methods keep them as is, don't add Async to it.

Comments

No response

@yaira2 yaira2 moved this from 🆕 New to 🔖 Ready to build in Files task board May 9, 2023
@yaira2
Copy link
Member

yaira2 commented May 9, 2023

@itsWindows11 do you want to work on this?

@itsWindows11
Copy link
Contributor Author

I'm currently busy with exams and stuff so haven't got much time to work on it unfortunately. Feel free to assign someone else to work on it.

@yaira2
Copy link
Member

yaira2 commented May 9, 2023

No worries, it's low priority anyways. I added it to the project board for tracking.

@gauravagrwal
Copy link

I will work on this

@itsWindows11
Copy link
Contributor Author

@yaira2 I might be able to work on it now this weekend.

@yaira2
Copy link
Member

yaira2 commented Sep 13, 2023

Thanks!

@Josh65-2201 Josh65-2201 moved this from 🔖 Ready to build to 🏗 In progress in Files task board Oct 19, 2023
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Files task board Oct 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants