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

Improve query API docs #4989

Closed
wants to merge 23 commits into from
Closed

Improve query API docs #4989

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
a028341
Squash and rebase
Nilirad Jun 16, 2022
3bdb3b2
State that query creation has a time-constant cost
Nilirad Jun 20, 2022
a422f60
Table vs sparse set query iteratino performance
Nilirad Jun 20, 2022
78f3707
Reference `Query` from `WorldQuery`
Nilirad Jun 20, 2022
9390982
Remove `WorldQuery` repetition in second paragraph
Nilirad Jun 20, 2022
6070f96
Add note about `for_each` vs `iter` performance
Nilirad Jun 21, 2022
87fc54c
Remove implementation detail from performance section
Nilirad Jul 1, 2022
6ea7bfb
Reword `for_each` performance
Nilirad Jul 1, 2022
b8d11ff
Remove `for_each` performance remarks from method descriptions
Nilirad Jul 1, 2022
799bd66
Add cross-links between `iter` and `for_each` methods
Nilirad Jul 1, 2022
bcaede4
Apply @james7132 suggestion on `for_each` performance
Nilirad Jul 2, 2022
5c02209
Break doc comments at clause or sentence boundaries
Nilirad Jul 2, 2022
f45630c
Split long line
Nilirad Jul 31, 2022
14d6182
Migrate `many_for_each_mut` → `iter_many_mut`
Nilirad Jul 31, 2022
1636b49
Fix `iter_many_mut` description
Nilirad Jul 31, 2022
be21bbd
Update `to_readonly` description
Nilirad Jul 31, 2022
90a3b16
Ref-style link revision
Nilirad Jul 31, 2022
a0a4275
Move `WorldQuery safety section up
Nilirad Jul 31, 2022
111ee3a
Apply suggestions from code review
Nilirad Aug 4, 2022
b9d3cea
Apply diff-based suggestions
Nilirad Aug 8, 2022
8950bfe
Remove duplicated and outdated “Safety” section
Nilirad Aug 8, 2022
a6b56df
Add link to `State` associated type
Nilirad Aug 8, 2022
706204f
Make clippy happy
Nilirad Aug 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading