Skip to content

[Merged by Bors] - Add docs & example for SystemParam#1435

Closed
woubuc wants to merge 5 commits intobevyengine:mainfrom
woubuc:dev/systemparam-docs
Closed

[Merged by Bors] - Add docs & example for SystemParam#1435
woubuc wants to merge 5 commits intobevyengine:mainfrom
woubuc:dev/systemparam-docs

Conversation

@woubuc
Copy link
Contributor

@woubuc woubuc commented Feb 12, 2021

It took me a little while to figure out how to use the SystemParam derive macro to easily create my own params. So I figured I'd add some docs and an example with what I learned.

  • Fixed a bug in the SystemParam derive macro where it didn't detect the correct crate name when used in an example (no longer relevant, replaced by [Merged by Bors] - fix bevy_ecs macro path handling #1426 - see further)
  • Added some doc comments and a short example code block in the docs for the SystemParam trait
  • Added a more complete example with explanatory comments in examples

@woubuc woubuc marked this pull request as draft February 14, 2021 12:15
@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-ECS Entities, components, systems, and events S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Feb 17, 2021
Base automatically changed from master to main February 19, 2021 20:44
# Conflicts:
#	crates/bevy_ecs/macros/src/lib.rs
@woubuc woubuc marked this pull request as ready for review February 22, 2021 10:24
@woubuc
Copy link
Contributor Author

woubuc commented Feb 22, 2021

I've fixed the conflicts from #1426 and replaced my local fix with the better fix from that commit. Should be good to go now.

@cart
Copy link
Member

cart commented Mar 3, 2021

Looks good to me. Thanks!

@cart
Copy link
Member

cart commented Mar 3, 2021

bors r+

bors bot pushed a commit that referenced this pull request Mar 3, 2021
It took me a little while to figure out how to use the `SystemParam` derive macro to easily create my own params. So I figured I'd add some docs and an example with what I learned.

- Fixed a bug in the `SystemParam` derive macro where it didn't detect the correct crate name when used in an example (no longer relevant, replaced by #1426 - see further)
- Added some doc comments and a short example code block in the docs for the `SystemParam` trait
- Added a more complete example with explanatory comments in examples
@bors
Copy link
Contributor

bors bot commented Mar 3, 2021

@bors bors bot changed the title Add docs & example for SystemParam [Merged by Bors] - Add docs & example for SystemParam Mar 3, 2021
@bors bors bot closed this Mar 3, 2021
@woubuc woubuc deleted the dev/systemparam-docs branch March 3, 2021 07:49
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.

5 participants