Skip to content

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

Closed
MrGVSV wants to merge 6 commits intobevyengine:mainfrom
MrGVSV:document-handles
Closed

[Merged by Bors] - Documented Handles and Assets#3348
MrGVSV wants to merge 6 commits intobevyengine:mainfrom
MrGVSV:document-handles

Conversation

@MrGVSV
Copy link
Member

@MrGVSV MrGVSV commented Dec 16, 2021

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
@alice-i-cecile
Copy link
Member

bors r+

bors bot pushed a commit that referenced this pull request Jan 4, 2022
# 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 <49806985+MrGVSV@users.noreply.github.com>
@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

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

Development

Successfully merging this pull request may close these issues.

Explain how to modify underlying asset

4 participants