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] - Documented Handles and Assets #3348

Closed
wants to merge 6 commits into from
Closed

[Merged by Bors] - Documented Handles and Assets #3348

wants to merge 6 commits into from

Conversation

MrGVSV
Copy link
Member

@MrGVSV MrGVSV commented Dec 16, 2021 •
edited
Loading

Objective

Add documentation to Handle and Assets.

Tasks

  • Document Handle
  • Document Assets

Fixes #3347

@github-actions github-actions bot added the S-Needs-Triage This issue needs to be labelled label Dec 16, 2021
@alice-i-cecile alice-i-cecile added A-Assets Load files from disk to use for things like images, models, and sounds C-Docs An addition or correction to our documentation and removed S-Needs-Triage This issue needs to be labelled labels Dec 16, 2021
@MrGVSV
Copy link
Member Author

MrGVSV commented Dec 16, 2021

Also added documentation to some of the methods for these structs while I was at it 📝

@MrGVSV MrGVSV marked this pull request as ready for review December 16, 2021 07:57
@mockersf mockersf mentioned this pull request Jan 3, 2022
Closed
12 tasks
@alice-i-cecile
Copy link
Member

bors r+

bors bot pushed a commit that referenced this pull request Jan 4, 2022
@MrGVSV
Documented Handles and Assets (#3348)
36390a8 
# Objective

Add documentation to [Handle](https://github.com/bevyengine/bevy/blob/7356f1586d74039f840bcfcf24af3e21c23e3c18/crates/bevy_asset/src/handle.rs#L63) and [Assets](https://github.com/bevyengine/bevy/blob/7356f1586d74039f840bcfcf24af3e21c23e3c18/crates/bevy_asset/src/assets.rs#L48).

## Tasks
- [x] Document `Handle`
- [x] Document `Assets`

---

Fixes #3347


Co-authored-by: MrGVSV <[email protected]>
@bors
Copy link
Contributor

bors bot commented Jan 4, 2022

Pull request successfully merged into main.

Build succeeded:

@bors bors bot changed the title Documented Handles and Assets [Merged by Bors] - Documented Handles and Assets Jan 4, 2022
@bors bors bot closed this Jan 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cart cart cart left review comments

@mockersf mockersf mockersf approved these changes

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

Assignees
No one assigned
Labels
A-Assets Load files from disk to use for things like images, models, and sounds C-Docs An addition or correction to our documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Explain how to modify underlying asset
4 participants
@MrGVSV @alice-i-cecile @cart @mockersf