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

[Merged by Bors] - Add documentation to ParamSet #6998

Closed
wants to merge 23 commits into from

Conversation

JoJoJet
Copy link
Member

@JoJoJet JoJoJet commented Dec 21, 2022

Objective

Fixes #4729.
Continuation of #4854.

Solution

Add documentation to ParamSet and its methods. Includes examples suggested by community members in the original PR.

Nanox19435 and others added 23 commits May 26, 2022 22:45
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>
Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>
… illustrate which problem System Param solves.
Co-authored-by: Federico Rinaldi <gisquerin@gmail.com>
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-Authored-By: Alice Cecile <alice.i.cecile@gmail.com>
Co-Authored-By: CGMossa <1063624+CGMossa@users.noreply.github.com>
@JoJoJet JoJoJet added C-Docs An addition or correction to our documentation A-ECS Entities, components, systems, and events labels Dec 21, 2022
@harudagondi harudagondi 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 Dec 24, 2022
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.

Thrilled to see this. Great doc example.

bors r+

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

Fixes #4729.
Continuation of #4854.

## Solution

Add documentation to `ParamSet` and its methods. Includes examples suggested by community members in the original PR.


Co-authored-by: Nanox19435 <50684926+Nanox19435@users.noreply.github.com>
Co-authored-by: JoJoJet <21144246+JoJoJet@users.noreply.github.com>
@bors bors bot changed the title Add documentation to ParamSet [Merged by Bors] - Add documentation to ParamSet Dec 25, 2022
@bors bors bot closed this Dec 25, 2022
@JoJoJet JoJoJet deleted the paramset-docs branch January 13, 2023 02:30
alradish pushed a commit to alradish/bevy that referenced this pull request Jan 22, 2023
# Objective

Fixes bevyengine#4729.
Continuation of bevyengine#4854.

## Solution

Add documentation to `ParamSet` and its methods. Includes examples suggested by community members in the original PR.


Co-authored-by: Nanox19435 <50684926+Nanox19435@users.noreply.github.com>
Co-authored-by: JoJoJet <21144246+JoJoJet@users.noreply.github.com>
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
# Objective

Fixes bevyengine#4729.
Continuation of bevyengine#4854.

## Solution

Add documentation to `ParamSet` and its methods. Includes examples suggested by community members in the original PR.


Co-authored-by: Nanox19435 <50684926+Nanox19435@users.noreply.github.com>
Co-authored-by: JoJoJet <21144246+JoJoJet@users.noreply.github.com>
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.

Add docs and doc examples to ParamSet
6 participants