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

Observe should state that Trigger<_> must be first arg #13860

Open
torsteingrindvik opened this issue Jun 15, 2024 · 1 comment
Open

Observe should state that Trigger<_> must be first arg #13860

torsteingrindvik opened this issue Jun 15, 2024 · 1 comment
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

@torsteingrindvik
Copy link
Contributor

How can Bevy's documentation be improved?

Observe

There is a limitation that Trigger<_> must be the first arg.

So currently when doing:

App::new().observe(f);

then:

/// works
fn foo(trigger: Trigger<Foo>, mut commands: Commands) {}

/// does not
fn bar(mut commands: Commands, trigger: Trigger<Foo>) {}

this should be documented.

@torsteingrindvik torsteingrindvik added C-Docs An addition or correction to our documentation S-Needs-Triage This issue needs to be labelled labels Jun 15, 2024
@alice-i-cecile alice-i-cecile added D-Trivial Nice and easy! A great choice to get started with Bevy A-ECS Entities, components, systems, and events and removed S-Needs-Triage This issue needs to be labelled labels Jun 15, 2024
@alice-i-cecile
Copy link
Member

We should ensure that the same note is present for exclusive and pipe systems while we're at it.

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 D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Development

No branches or pull requests

2 participants