Skip to content

Commit

Permalink
Fix doc in App::add_sub_app (bevyengine#7139)
Browse files Browse the repository at this point in the history
# Objective

- Fix the name of function parameter name in docs

## Solution

- Change `f` to `sub_app_runner`

---

It confused me a bit when I was reading the docs in the autocomplete hint.
Hesitated about filing a PR since it's just a one single word change in the comment.
Is this the right process to change these docs?
  • Loading branch information
2ne1ugly authored and ItsDoot committed Feb 1, 2023
1 parent 68c5be7 commit 7e8623b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion crates/bevy_app/src/app.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1018,7 +1018,7 @@ impl App {

/// Adds an [`App`] as a child of the current one.
///
/// The provided function `f` is called by the [`update`](Self::update) method. The [`World`]
/// The provided function `sub_app_runner` is called by the [`update`](Self::update) method. The [`World`]
/// parameter represents the main app world, while the [`App`] parameter is just a mutable
/// reference to the `SubApp` itself.
pub fn add_sub_app(
Expand Down

0 comments on commit 7e8623b

Please sign in to comment.