Skip to content

Conversation

@2ne1ugly
Copy link
Contributor

@2ne1ugly 2ne1ugly commented Jan 9, 2023

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?

@2ne1ugly 2ne1ugly force-pushed the fix-add-sub-app-doc branch from 0a8d61d to 10478a3 Compare January 9, 2023 13:46
@2ne1ugly 2ne1ugly force-pushed the fix-add-sub-app-doc branch from 10478a3 to cf03048 Compare January 9, 2023 13:48
@james7132 james7132 added 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 labels Jan 9, 2023
Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bors r+

bors bot pushed a commit that referenced this pull request Jan 9, 2023
# 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?
@bors
Copy link
Contributor

bors bot commented Jan 9, 2023

Build failed (retrying...):

bors bot pushed a commit that referenced this pull request Jan 9, 2023
# 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?
@bors bors bot changed the title Fix doc in App::add_sub_app [Merged by Bors] - Fix doc in App::add_sub_app Jan 9, 2023
@bors bors bot closed this Jan 9, 2023
@2ne1ugly 2ne1ugly deleted the fix-add-sub-app-doc branch January 10, 2023 00:40
james7132 pushed a commit to james7132/bevy that referenced this pull request Jan 21, 2023
# 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?
alradish pushed a commit to alradish/bevy that referenced this pull request Jan 22, 2023
# 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?
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
# 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?
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.

3 participants