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

Documentation (and examples) for: to, do, back #975

Open
SquirrelModeller opened this issue Mar 8, 2024 · 0 comments
Open

Documentation (and examples) for: to, do, back #975

SquirrelModeller opened this issue Mar 8, 2024 · 0 comments
Labels
a-core Relates to the core package b-documentation Improvements or additions to documentation c-accepted The issue is ready to be worked on

Comments

@SquirrelModeller
Copy link

Description
The documentation, to my knowledge, lacks information on the property: do

One scenario where this documentation would be useful would be for showing how to execute code after an action is performed.

An example would be removing an element after an action is performed:
yield node.opacity(0, 1).do(() => node.remove())

I suggest adding examples of how these properties are used in the "docs" section. The property back is already demonstrated in the section "Scene hierarchy". Likewise to is demonstrated in "Animation flow". It seems inconsistent to omit do. I also suggest pooling the properties together and explaining them all.

@SquirrelModeller SquirrelModeller added the b-documentation Improvements or additions to documentation label Mar 8, 2024
@aarthificial aarthificial removed their assignment Mar 11, 2024
@aarthificial aarthificial added c-accepted The issue is ready to be worked on a-core Relates to the core package labels Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a-core Relates to the core package b-documentation Improvements or additions to documentation c-accepted The issue is ready to be worked on
Projects
None yet
Development

No branches or pull requests

2 participants