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

[Merged by Bors] - AppExit documentation updates (#7067) #7347

Closed
wants to merge 1 commit into from

Conversation

Testare
Copy link
Contributor

@Testare Testare commented Jan 23, 2023

Objective

Help users understand how to write code that runs when the app is exiting.

See:

Solution

Added documentation to AppExit class that mentions using the Drop trait for code that needs to run on program exit, as well as linking to the caveat about App::run() not being guaranteed to return.

# Objective

Help users understand how to write code that runs when the app is
exiting.

See:

- bevyengine#7067 (Partial resolution)

## Solution

Added documentation to `AppExit` class that mentions using the `Drop`
trait for code that needs to run on program exit, as well as linking
to the caveat about `App::run()` not being guaranteed to return.
@james7132 james7132 added C-Docs An addition or correction to our documentation A-App Bevy apps and plugins labels Jan 23, 2023
@mockersf mockersf added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jan 23, 2023
@james7132
Copy link
Member

bors r+

bors bot pushed a commit that referenced this pull request Jan 23, 2023
# Objective

Help users understand how to write code that runs when the app is exiting.

See:

- #7067 (Partial resolution)

## Solution

Added documentation to `AppExit` class that mentions using the `Drop` trait for code that needs to run on program exit, as well as linking to the caveat about `App::run()` not being guaranteed to return.
@bors bors bot changed the title AppExit documentation updates (#7067) [Merged by Bors] - AppExit documentation updates (#7067) Jan 23, 2023
@bors bors bot closed this Jan 23, 2023
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
# Objective

Help users understand how to write code that runs when the app is exiting.

See:

- bevyengine#7067 (Partial resolution)

## Solution

Added documentation to `AppExit` class that mentions using the `Drop` trait for code that needs to run on program exit, as well as linking to the caveat about `App::run()` not being guaranteed to return.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-App Bevy apps and plugins C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants