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

Add docs and doc examples to ParamSet #4729

Closed
alice-i-cecile opened this issue May 12, 2022 · 0 comments
Closed

Add docs and doc examples to ParamSet #4729

alice-i-cecile opened this issue May 12, 2022 · 0 comments
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@alice-i-cecile
Copy link
Member

How can Bevy's documentation be improved?

ParamSets are useful but relatively advanced tools for accessing multiple mutually exclusive system parameters at a time.

However the current docs are non-existent.

We should have:

  1. A basic description of why they're used.
  2. An explanation that you can only access one element at a time.
  3. A relatively simple example demonstrating this.

See: https://bevy-cheatbook.github.io/programming/paramset.html?highlight=paramset#param-sets for a starting point.
@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy A-ECS Entities, components, systems, and events labels May 12, 2022
@Nanox19435 Nanox19435 mentioned this issue May 27, 2022
Closed
@JoJoJet JoJoJet mentioned this issue Dec 21, 2022
Closed
@bors bors bot closed this as completed in fa2b5f2 Dec 25, 2022
alradish pushed a commit to alradish/bevy that referenced this issue Jan 22, 2023
@Nanox19435 @JoJoJet @alradish
Add documentation to ParamSet (bevyengine#6998)
6341d44 
# 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 issue Feb 1, 2023
@Nanox19435 @JoJoJet @ItsDoot
Add documentation to ParamSet (bevyengine#6998)
26c57a9 
# 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
Assignees
No one assigned
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Milestone
No milestone
1 participant
@alice-i-cecile