bevyengine / bevyengine/bevy

Function signature of `resource_equals` differs from implementation in docs

Open
#8,898 7 comments 0 reactions 0 assignees View on GitHub
A-ECS C-Docs S-Blocked
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 22h
Merged PRs (30d)
161

Description

## How can Bevy's documentation be improved?

In the latest version of bevys docs, the signature of [`resource_equals`](https://docs.rs/bevy/latest/bevy/ecs/schedule/common_conditions/fn.resource_equals.html) seems to be buggy.

I was looking into how the common run conditions were implemented and was a bit confused when I saw this

![image](https://github.com/bevyengine/bevy/assets/26892280/84dd2839-32c7-48c0-b88f-14fb41d8ba7b)

I needed to check the bevy repos code to verify that the returned closure returns a `bool`.

![image](https://github.com/bevyengine/bevy/assets/26892280/79517f3d-e5c6-4d8d-88c1-d91e11d54c85)

I don't know how to fix it yet though, but I'll see what I can do!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.