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

Are the random_sampling and sampling_primitives examples redundant? #15823

Open
rparrett opened this issue Oct 10, 2024 · 2 comments · May be fixed by #16453
Open

Are the random_sampling and sampling_primitives examples redundant? #15823

rparrett opened this issue Oct 10, 2024 · 2 comments · May be fixed by #16453
Labels
A-Math Fundamental domain-agnostic mathematical operations C-Bug An unexpected or incorrect behavior C-Examples An addition or correction to our examples D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Implementation This issue is ready for an implementation PR. Go for it!

Comments

@rparrett
Copy link
Contributor

Bevy version

main

What you did

cargo run --example random_sampling
Added in #13507

cargo run --example sampling_primitives
Added in #13519

What went wrong

These examples appear to be extremely similar, and their docs even have identical descriptions.

//! This example shows how to sample random points from primitive shapes.

Additional information

It appears that this isn't a mistake, so I would suggest updating the description of either or both examples to explain what each of them is accomplishing.

But they seem totally redundant to me, so removing one may be an option.

@rparrett rparrett added C-Bug An unexpected or incorrect behavior S-Needs-Triage This issue needs to be labelled labels Oct 10, 2024
@alice-i-cecile alice-i-cecile added D-Trivial Nice and easy! A great choice to get started with Bevy C-Examples An addition or correction to our examples A-Math Fundamental domain-agnostic mathematical operations S-Ready-For-Implementation This issue is ready for an implementation PR. Go for it! and removed S-Needs-Triage This issue needs to be labelled labels Oct 10, 2024
@alice-i-cecile
Copy link
Member

I vote redundant. Remove sampling_primitives.

@mweatherley
Copy link
Contributor

For some context: I originally wrote the random_sampling example just to demonstrate what ShapeSample was and how to use it. The intention of sampling_primitives (which came shortly after) was to show off the range of primitives for which this sampling feature was supported. I don't have strong feelings about whether one of them gets removed or something. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Math Fundamental domain-agnostic mathematical operations C-Bug An unexpected or incorrect behavior C-Examples An addition or correction to our examples D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Implementation This issue is ready for an implementation PR. Go for it!
Projects
None yet
3 participants