Document CommandBuffer.remove() will not remove any if it does not match all components
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.4k
- Forks
- 107
- Avg merge
- 2h
- Merged PRs (30d)
- 6
Description
https://docs.rs/hecs/latest/hecs/struct.CommandBuffer.html#method.remove
Remove components from entity if they exist
Mislead me into thinking "Oh, I can just specify a whole bunch of components and it will remove them if they don't exist"
When really it should be mentioned they must match all just like World.remove()
https://docs.rs/hecs/latest/hecs/struct.World.html#method.remove
If any component in T is not present in entity, no components are removed and an error is returned.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the CommandBuffer.remove() documentation on docs.rs and compare its wording with World.remove(). Confirm the documented behavior for partial component matches, then update the CommandBuffer description so it states that all requested components must be present for removal. Done when the documentation no longer implies that missing components are ignored.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100