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

insert_non_send_resource doesnt document panics #6277

Closed
BoxyUwU opened this issue Oct 17, 2022 · 0 comments
Closed

insert_non_send_resource doesnt document panics #6277

BoxyUwU opened this issue Oct 17, 2022 · 0 comments
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@BoxyUwU
Copy link
Member

BoxyUwU commented Oct 17, 2022

fn insert_non_send_resource should explain that it panics when called from not-the-main-thread
@BoxyUwU BoxyUwU added C-Docs An addition or correction to our documentation S-Needs-Triage This issue needs to be labelled labels Oct 17, 2022
@alice-i-cecile alice-i-cecile added D-Trivial Nice and easy! A great choice to get started with Bevy A-ECS Entities, components, systems, and events and removed S-Needs-Triage This issue needs to be labelled labels Oct 17, 2022
@lovelymono lovelymono mentioned this issue Oct 21, 2022
Closed
bors bot pushed a commit that referenced this issue Oct 21, 2022
@lovelymono
document insert_non_send_resource panics (#6328)
2cdfb5e 
Signed-off-by: Lena Milizé <[email protected]>

# 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 bot pushed a commit that referenced this issue Oct 24, 2022
@lovelymono
document insert_non_send_resource panics (#6328)
7874064 
Signed-off-by: Lena Milizé <[email protected]>

# 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 bors bot closed this as completed in b2f223b Oct 24, 2022
james7132 pushed a commit to james7132/bevy that referenced this issue Oct 28, 2022
@lovelymono @james7132
document insert_non_send_resource panics (bevyengine#6328)
abef7ba 
Signed-off-by: Lena Milizé <[email protected]>

# 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 issue Dec 17, 2022
@lovelymono @Pietrek14
document insert_non_send_resource panics (bevyengine#6328)
ba58822 
Signed-off-by: Lena Milizé <[email protected]>

# 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 issue Feb 1, 2023
@lovelymono @ItsDoot
document insert_non_send_resource panics (bevyengine#6328)
c94a067 
Signed-off-by: Lena Milizé <[email protected]>

# 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
Assignees
No one assigned
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Merged by Bors] - document insert_non_send_resource panics
2 participants
@alice-i-cecile @BoxyUwU