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.

Sign up for GitHub

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

Jump to bottom

[Merged by Bors] - document insert_non_send_resource panics #6328

Closed
wants to merge 4 commits into from
Closed

[Merged by Bors] - document insert_non_send_resource panics #6328

wants to merge 4 commits into from

Conversation

lovelymono
Copy link
Contributor

Signed-off-by: Lena Milizé me@lvmn.org

Objective

Fixes #6277.

Solution

Adds # Panics section to fn insert_non_send_resource documentation, which explains that it panics when called from thread other than main thread.

@lovelymono
document insert_non_send_resource panics
54e6855 
Signed-off-by: Lena Milizé <me@lvmn.org>
@lovelymono @tim-blackbird
fix spelling
f974850 
Co-authored-by: ira <JustTheCoolDude@gmail.com>
alice-i-cecile
alice-i-cecile approved these changes Oct 21, 2022
View reviewed changes
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.

Thanks! Merging as trivial.

bors r+

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-ECS Entities, components, systems, and events labels Oct 21, 2022
bors bot pushed a commit that referenced this pull request Oct 21, 2022
@lovelymono
document insert_non_send_resource panics (#6328)
2cdfb5e 
Signed-off-by: Lena Milizé <me@lvmn.org>

# Objective

Fixes #6277.

## Solution

Adds `# Panics` section to [`fn insert_non_send_resource`](http://dev-docs.bevyengine.org/bevy/ecs/world/struct.World.html#method.insert_non_send_resource) documentation, which explains that it panics when called from thread other than main thread.
@hymm
Copy link
Contributor

hymm commented Oct 21, 2022

init_non_send_resource probably needs docs for this too.

@alice-i-cecile
Copy link
Member

bors r-

@bors
Copy link
Contributor

bors bot commented Oct 21, 2022

Canceled.

lovelymono and others added 2 commits October 21, 2022 19:54
@lovelymono @mockersf
fix formatting
843db74 
Co-authored-by: François <mockersf@gmail.com>
@lovelymono @hymm
document init_non_send_resource panics
447680d 
Co-authored-by: Mike <mike.hsu@gmail.com>
@alice-i-cecile alice-i-cecile 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 Oct 21, 2022
@alice-i-cecile
Copy link
Member

bors r+

bors bot pushed a commit that referenced this pull request Oct 24, 2022
@lovelymono
document insert_non_send_resource panics (#6328)
7874064 
Signed-off-by: Lena Milizé <me@lvmn.org>

# Objective

Fixes #6277.

## Solution

Adds `# Panics` section to [`fn insert_non_send_resource`](http://dev-docs.bevyengine.org/bevy/ecs/world/struct.World.html#method.insert_non_send_resource) documentation, which explains that it panics when called from thread other than main thread.
@bors
Copy link
Contributor

bors bot commented Oct 24, 2022

Build failed (retrying...):

bors bot pushed a commit that referenced this pull request Oct 24, 2022
@lovelymono
document insert_non_send_resource panics (#6328)
b2f223b 
Signed-off-by: Lena Milizé <me@lvmn.org>

# Objective

Fixes #6277.

## Solution

Adds `# Panics` section to [`fn insert_non_send_resource`](http://dev-docs.bevyengine.org/bevy/ecs/world/struct.World.html#method.insert_non_send_resource) documentation, which explains that it panics when called from thread other than main thread.
@bors
Copy link
Contributor

bors bot commented Oct 24, 2022

Pull request successfully merged into main.

Build succeeded:

@bors bors bot changed the title document insert_non_send_resource panics [Merged by Bors] - document insert_non_send_resource panics Oct 24, 2022
@bors bors bot closed this Oct 24, 2022
james7132 pushed a commit to james7132/bevy that referenced this pull request Oct 28, 2022
@lovelymono @james7132
document insert_non_send_resource panics (bevyengine#6328)
abef7ba 
Signed-off-by: Lena Milizé <me@lvmn.org>

# Objective

Fixes bevyengine#6277.

## Solution

Adds `# Panics` section to [`fn insert_non_send_resource`](http://dev-docs.bevyengine.org/bevy/ecs/world/struct.World.html#method.insert_non_send_resource) documentation, which explains that it panics when called from thread other than main thread.
Pietrek14 pushed a commit to Pietrek14/bevy that referenced this pull request Dec 17, 2022
@lovelymono @Pietrek14
document insert_non_send_resource panics (bevyengine#6328)
ba58822 
Signed-off-by: Lena Milizé <me@lvmn.org>

# Objective

Fixes bevyengine#6277.

## Solution

Adds `# Panics` section to [`fn insert_non_send_resource`](http://dev-docs.bevyengine.org/bevy/ecs/world/struct.World.html#method.insert_non_send_resource) documentation, which explains that it panics when called from thread other than main thread.
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
@lovelymono @ItsDoot
document insert_non_send_resource panics (bevyengine#6328)
c94a067 
Signed-off-by: Lena Milizé <me@lvmn.org>

# Objective

Fixes bevyengine#6277.

## Solution

Adds `# Panics` section to [`fn insert_non_send_resource`](http://dev-docs.bevyengine.org/bevy/ecs/world/struct.World.html#method.insert_non_send_resource) documentation, which explains that it panics when called from thread other than main thread.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tim-blackbird tim-blackbird tim-blackbird approved these changes

@mockersf mockersf mockersf approved these changes

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

Assignees
No one assigned
Labels
A-ECS Entities, components, systems, and events 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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

insert_non_send_resource doesnt document panics
5 participants
@lovelymono @hymm @alice-i-cecile @mockersf @tim-blackbird