godotengine / godotengine/godot-docs
GDScript section on Awaiting for Signals says await immediately returns control to caller
- Dominant language
- reStructuredText
- Stars
- 5.7k
- Forks
- 3.8k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 25
Description
**Docs version**
Godot 4.0.beta, "latest" at 2023-02-03
**Issue description:**
The documentation wrongly describes how `await` works, I believe.
**URL to the documentation page:**
https://github.com/godotengine/godot-docs/blob/8f0a570fcfcf924c6e2fffe63082cf6de3ed001e/tutorials/scripting/gdscript/gdscript_basics.rst#awaiting-for-signals
Excerpt from the section linked above:
> Using the await keyword with a signal or a call to a function that is also a coroutine will *immediately return the control to the caller*.
- Surely, the `await` keyword causes the caller to **wait**, for the signal or coroutine? It's a blocking call?
- In context, the above cited sentence isn't perhaps needed at all?
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.