docs: fix the description of when to use the synchronous function #3849
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
area/docs
sobolevn
reviewed
Nov 7, 2024
sobolevn
approved these changes
Nov 7, 2024
cofin
approved these changes
Nov 16, 2024
cofin
force-pushed
the
vvanglro-patch-1
branch
from
718d452 to
284f9d2
Compare
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3849 |
| @@ -101,7 +101,7 @@ When to use a synchronous function | |||
| ---------------------------------- | |||
|
|
|||
| As an inverse of the previous paragraph, it follows that synchronous functions should | |||
| be used for non-blocking, non-computationally intensive tasks. The synchronous execution | |||
| be used for non-io intensive tasks. The synchronous execution | |||
There was a problem hiding this comment.
This makes it sound like you should use synchronous functions for lightweight IO tasks, which is the opposite of what the paragraph is trying to say
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Closes