Skip to content

[Merged by Bors] - Basic EntityRef and EntityMut docs#3388

Closed
alice-i-cecile wants to merge 3 commits intobevyengine:mainfrom
alice-i-cecile:entity-ref-docs
Closed

[Merged by Bors] - Basic EntityRef and EntityMut docs#3388
alice-i-cecile wants to merge 3 commits intobevyengine:mainfrom
alice-i-cecile:entity-ref-docs

Conversation

@alice-i-cecile
Copy link
Member

Objective

  • EntityRef and EntityMut are surpisingly important public types when working directly with the World.
  • They're undocumented.

Solution

  • Just add docs!

@alice-i-cecile alice-i-cecile added A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation labels Dec 19, 2021
@github-actions github-actions bot added the S-Needs-Triage This issue needs to be labelled label Dec 19, 2021
@alice-i-cecile alice-i-cecile removed the S-Needs-Triage This issue needs to be labelled label Dec 19, 2021
@james7132 james7132 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 Mar 21, 2022
@alice-i-cecile
Copy link
Member Author

bors r+

bors bot pushed a commit that referenced this pull request Mar 21, 2022
# Objective

- `EntityRef` and `EntityMut` are surpisingly important public types when working directly with the `World`.
- They're undocumented.

## Solution

- Just add docs!
@bors
Copy link
Contributor

bors bot commented Mar 21, 2022

Build failed:

};
use std::any::TypeId;

/// A read-only reference to a particular [Entity] and all of its components
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
/// A read-only reference to a particular [Entity] and all of its components
/// A read-only reference to a particular [`Entity`] and all of its components

@alice-i-cecile
Copy link
Member Author

bors r+

bors bot pushed a commit that referenced this pull request Apr 25, 2022
# Objective

- `EntityRef` and `EntityMut` are surpisingly important public types when working directly with the `World`.
- They're undocumented.

## Solution

- Just add docs!
@bors bors bot changed the title Basic EntityRef and EntityMut docs [Merged by Bors] - Basic EntityRef and EntityMut docs Apr 25, 2022
@bors bors bot closed this Apr 25, 2022
exjam pushed a commit to exjam/bevy that referenced this pull request May 22, 2022
# Objective

- `EntityRef` and `EntityMut` are surpisingly important public types when working directly with the `World`.
- They're undocumented.

## Solution

- Just add docs!
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
# Objective

- `EntityRef` and `EntityMut` are surpisingly important public types when working directly with the `World`.
- They're undocumented.

## Solution

- Just add docs!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

Development

Successfully merging this pull request may close these issues.

3 participants