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

docs: move await to explicit line for clarity #2577

Merged
merged 2 commits into from
Jul 1, 2024
Merged

Conversation

iiio2
Copy link
Contributor

@iiio2 iiio2 commented Jul 1, 2024

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

Async function always returns a promise. There is no need to explicitly write await unless it is within try/catch. I think here await is kind of redundant.

https://eslint.org/docs/latest/rules/no-return-await
https://dev.to/danielbellmas/return-await-in-a-trycatch-4oh

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@pi0
Copy link
Member

pi0 commented Jul 1, 2024

Thanks for PR but probably await can stay there it was mostly to show users it returns a promise. (updated to make it two liner for more clarity)

@pi0 pi0 closed this Jul 1, 2024
@pi0 pi0 reopened this Jul 1, 2024
docs/1.guide/8.assets.md Outdated Show resolved Hide resolved
@pi0 pi0 changed the title docs: remove redundant await in promise docs: move await to explicit line for clarity Jul 1, 2024
@pi0 pi0 merged commit 96b1d7c into nitrojs:v2 Jul 1, 2024
4 checks passed
@iiio2 iiio2 deleted the patch-1 branch July 1, 2024 16:52
@iiio2
Copy link
Contributor Author

iiio2 commented Jul 1, 2024

Thanks @pi0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants