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

Document var x = await signal returns signal arguments. #10521

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

ahmed-tabib
Copy link

The await keyword being able to return signal arguments is not documented anywhere. There is also a special behavior, where if the signal returns more than one argument the await keyword returns an Array with the arguments in order.

  • Documented the behavior in the "GDScript Reference" page, under pre-existing section "Awaiting signals or coroutines", and added some tested usage examples.
  • Mentioned the behavior and added a reference in the "Using Signals" page, under a new section "Awaiting signals", near the end.

This PR addresses the following issue: #8393

@ahmed-tabib ahmed-tabib marked this pull request as draft January 20, 2025 11:08
@ahmed-tabib ahmed-tabib marked this pull request as ready for review January 20, 2025 11:19
@skyace65 skyace65 added area:getting started Issues and PRs related to the Getting Started section of the documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation labels Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:getting started Issues and PRs related to the Getting Started section of the documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants