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.

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

Finish documenting bevy_scene #9949

Merged
merged 1 commit into from
Oct 1, 2023

Conversation

Kanabenki
Copy link
Contributor

Objective

Finish documenting bevy_scene.

Solution

Document the remaining items and add a crate-level warn(missing_doc) attribute as for the other crates with completed documentation.

Copy link
Contributor

@nicopap nicopap left a comment

Choose a reason for hiding this comment

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

Nice job! I really like it. I added a couple suggestions, but as-is, it's already good to go for me!

crates/bevy_scene/src/scene_loader.rs Outdated Show resolved Hide resolved
crates/bevy_scene/src/scene_spawner.rs Outdated Show resolved Hide resolved
crates/bevy_scene/src/scene_spawner.rs Outdated Show resolved Hide resolved
crates/bevy_scene/src/scene_spawner.rs Outdated Show resolved Hide resolved
crates/bevy_scene/src/scene_spawner.rs Outdated Show resolved Hide resolved
crates/bevy_scene/src/serde.rs Show resolved Hide resolved
@nicopap nicopap added C-Docs An addition or correction to our documentation A-Scenes Serialized ECS data stored on the disk labels Sep 28, 2023
@Kanabenki Kanabenki force-pushed the bevy_scene-doc branch 2 times, most recently from eee4f04 to 4cd1c5b Compare September 28, 2023 13:05
crates/bevy_scene/src/lib.rs Outdated Show resolved Hide resolved
crates/bevy_scene/src/lib.rs Outdated Show resolved Hide resolved
crates/bevy_scene/src/scene_spawner.rs Outdated Show resolved Hide resolved
crates/bevy_scene/src/scene_spawner.rs Outdated Show resolved Hide resolved
crates/bevy_scene/src/scene_spawner.rs Outdated Show resolved Hide resolved
crates/bevy_scene/src/scene_spawner.rs Outdated Show resolved Hide resolved
crates/bevy_scene/src/serde.rs Outdated Show resolved Hide resolved
crates/bevy_scene/src/serde.rs Outdated Show resolved Hide resolved
crates/bevy_scene/src/serde.rs Outdated Show resolved Hide resolved
crates/bevy_scene/src/serde.rs Outdated Show resolved Hide resolved
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.

Really nice stuff, thanks!

@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 Sep 28, 2023
Document the remaining items and add a `warn(missing_doc)` crate
attribute.
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Oct 1, 2023
Merged via the queue into bevyengine:main with commit ec34fe0 Oct 1, 2023
21 checks passed
ameknite pushed a commit to ameknite/bevy that referenced this pull request Oct 3, 2023
# Objective

Finish documenting `bevy_scene`.

## Solution

Document the remaining items and add a crate-level `warn(missing_doc)`
attribute as for the other crates with completed documentation.
ameknite pushed a commit to ameknite/bevy that referenced this pull request Oct 3, 2023
# Objective

Finish documenting `bevy_scene`.

## Solution

Document the remaining items and add a crate-level `warn(missing_doc)`
attribute as for the other crates with completed documentation.
regnarock pushed a commit to regnarock/bevy that referenced this pull request Oct 13, 2023
# Objective

Finish documenting `bevy_scene`.

## Solution

Document the remaining items and add a crate-level `warn(missing_doc)`
attribute as for the other crates with completed documentation.
rdrpenguin04 pushed a commit to rdrpenguin04/bevy that referenced this pull request Jan 9, 2024
# Objective

Finish documenting `bevy_scene`.

## Solution

Document the remaining items and add a crate-level `warn(missing_doc)`
attribute as for the other crates with completed documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Scenes Serialized ECS data stored on the disk 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.

5 participants