-
-
Notifications
You must be signed in to change notification settings - Fork 3.9k
[Merged by Bors] - Improve bevy_ecs and bevy_app API docs where referenced by the new Bevy Book #2365
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
Closed
Closed
[Merged by Bors] - Improve bevy_ecs and bevy_app API docs where referenced by the new Bevy Book #2365
Changes from 1 commit
Commits
Show all changes
151 commits
Select commit
Hold shift + click to select a range
4d1040a
Improve App docs
Nilirad 54954bc
Move App doc example to AppBuilder
Nilirad 6db1fce
Document App methods
Nilirad b7436de
Restore App example to original position
Nilirad 71f4541
Clarify App::update method doc comment
Nilirad 62258d4
Document AppBuilder fns and some relative items
Nilirad 3d34f02
Add StartupStage enum link to add_default_stages
Nilirad ba27b4f
Correct enum keyword monospace text
Nilirad 862ccb3
Add docs for mod system
Nilirad cfe0755
Point stage links to add_default_stages
Nilirad 043b31a
Merge branch 'main' into api-docs-ch1
Nilirad c1fc50b
Update crates/bevy_ecs/src/system/mod.rs
Nilirad f29e769
Correct add_startup_system_to_stage docs
Nilirad 7c66d20
Document new AppBuilder methods
Nilirad 3f9d879
Remove incorrect references to StartupStage
Nilirad 483f312
Add module-level documentation for entity
Nilirad dad4c5e
Improve sentence wording
Nilirad c693223
Query module-level documentation
Nilirad ac52aa3
Remove duplicate info on resource init methods
Nilirad 2cc360c
Refactor Query docs in a more structured way
Nilirad 16f9a87
Add `Added` and `Changed` filters
Nilirad 307ea91
Add link to Query in mod query docs
Nilirad 348985f
Add query iteration docs
Nilirad 5676e45
FIx doctests
Nilirad 7e11aa1
Fix link to Query
Nilirad 2f8f7f9
Add list of system parameters
Nilirad 94fee6c
Improve add_default_stages wording
Nilirad 78ce084
Improve add_default_stages wording
Nilirad 8f34675
Add Optional (Non)Send SystemParams
Nilirad 7945a66
Merge branch 'main' into api-docs-ch1
Nilirad eaa4e72
Add SystemParam requirement
Nilirad f13dcb5
Add Schedule struct and module documentation
Nilirad d517f57
Link to Stage
Nilirad 083adf0
Add brief description of Stage trait
Nilirad 7610e8b
Add crate general info and module summaries
Nilirad bafbda6
Improve resource documentation
Nilirad a72840b
Merge branch 'bevyengine:main' into api-docs-ch1
Nilirad ba506b9
Yeet .system() from resource doctest
Nilirad 132043e
Remove unnecessary comma
Nilirad 54aa4ef
Improve Bundle docs
Nilirad c7cdfd0
Add dash in ECS-based
Nilirad 79ce84d
Fix grammar
Nilirad 8b16e36
Improve WithBundle docs
Nilirad 70373f7
Improve sentence conciseness
Nilirad 58e1d30
Improve entity use-case list order
Nilirad 2a9369a
Improve grammar
Nilirad 681e2e9
Improve grammar
Nilirad 5b8c8e9
Improve query filter list header
Nilirad 0e1328d
Improve App::run docs
Nilirad 5600265
Describe default behavior of init_resource
Nilirad db34dd4
Specify that Schedule stages run in linear order
Nilirad 0aa09d7
uwu
Nilirad 647c322
Invert sentence for query single component access
Nilirad 5363519
Add multiple query filters example
Nilirad cc92352
Change Schedule to Stage in schedule mod docs
Nilirad 5fa6f0a
Separate resource from Component
Nilirad 4856db0
Merge branch 'bevyengine:main' into api-docs-ch1
Nilirad 171b0a2
Add usefulness of nested Schedules
Nilirad 26794d9
Merge branch 'api-docs-ch1' of github.com:Nilirad/bevy into api-docs-ch1
Nilirad 84e78f2
Change "update" to "my_stage" in example
Nilirad 549db69
Enumerate default stages
Nilirad 565a69a
Correct concurrent mutable component access
Nilirad a9bc51e
Fix typo
Nilirad 2eb507a
Correct query concurrent mutable access
Nilirad 0026994
Clarify use of `func` parameter
Nilirad bf94f67
Update query mutable component access descriptions
Nilirad 9059588
Update mod system docs
Nilirad 9d334e8
Add examples to AppBuilder methods
Nilirad ef830b6
Merge branch 'bevyengine:main' into api-docs-ch1
Nilirad 696bbb4
Fix scheduler typo
Nilirad 76ab530
Improve query result usage
Nilirad a705bfe
Remove code block for type parameters of Query
Nilirad 9bb6e1c
Use a more specific Query summary description
Nilirad 9482315
Define "query result"
Nilirad 86dd7f7
Avoid using "contemporarily"
Nilirad eea7f53
Query system parameter usage intro
Nilirad 20581b7
Merge branch 'api-docs-ch1' of github.com:Nilirad/bevy into api-docs-ch1
Nilirad fc52b1b
Add examples to Query iter and iter_mut methods
Nilirad 6254589
Remove Res<Time> from Query::iter_mut example
Nilirad 293702d
Fix mod system doctest
Nilirad 7b2a818
General Query docs improvements
Nilirad 5d15897
Add Query methods docs
Nilirad 4ac95eb
Improve wording
Nilirad 8972641
Add example to Query::get
Nilirad 865d722
Rename Target to Winner
Nilirad 9319ced
Rename Target to Winner, part 2
Nilirad 4594d13
Add third person "s" verb suffix
Nilirad 933cc9f
Add Query::get_component example
Nilirad 0bdc8ab
Use a more concise example for Query::get
Nilirad 57333e0
Add example to Query::get_component_mut
Nilirad 6c82809
Add example for Query::get_mut
Nilirad 14155ce
Add .system() to check examples' SystemParams
Nilirad 33c8a1c
Add example to Query::is_empty
Nilirad c68dd21
Update examples for Query::{single, single_mut}
Nilirad d88b46a
Query: use "Returns" instead of "Gets"
Nilirad c0eddb6
Add error case info for Query methods
Nilirad b7ae0c7
Link to `SystemParam`
Nilirad 96a63aa
Add metadata notes to some `SystemParam`s in list
Nilirad 8c66a92
Improve `WithBundle` summary
Nilirad f3cedeb
Listify safety notes for `Bundle`
Nilirad eda2f90
Reference example on top for `AppBuilder::run`
Nilirad 788a817
Improve wording
Nilirad 358f825
Remove "most relevant"
Nilirad 7d3d8ce
Expand mutable query guidelines
Nilirad 8a4c679
Remove empty code block
Nilirad 5bd7d6a
Merge branch 'api-docs-ch1' of github.com:Nilirad/bevy into api-docs-ch1
Nilirad 26aaade
Add `Commands` method examples
Nilirad 3372b7b
Add `EntityCommands` method examples
Nilirad fad5a32
hi
Nilirad 208377e
Merge branch 'main' of https://github.com/bevyengine/bevy into bevyen…
Nilirad b9b33b5
Merge branch 'bevyengine-main' into api-docs-ch1
Nilirad e2bea20
Apply suggestions
Nilirad 6395011
Misc improvements
Nilirad 230eff1
Merge branch 'bevyengine:main' into api-docs-ch1
Nilirad 34b68b3
Update `WithBundle` description
Nilirad 50fb8c9
Resolve conflicts caused by app_builder.rs removal
Nilirad 0501747
Merge branch 'bevyengine-main' into api-docs-ch1
Nilirad ad87266
Fix doctests and remove refs to `AppBuilder`
Nilirad 85caa4b
Resolve merge conflicts
Nilirad 3d9a857
Merge branch 'bevyengine-main' into api-docs-ch1
Nilirad 090e923
Add examples to `Schedule` methods
Nilirad 779e983
Include `REAME.md` as `bevy_ecs` crate level docs
Nilirad 32c20be
Remove newline
Nilirad de82c53
return -> yield
Nilirad acaefb4
Style
Nilirad 61395f7
Entity: handle -> ID
Nilirad bdfe0c2
Entity ID
Nilirad cd2b9ba
Add context to some `Query` method examples
Nilirad 6d30e1d
wow
Nilirad 4d39725
Unit `Bundle` is not a thing
Nilirad e9b22fa
Correct mod `archetype` summary
Nilirad 8ebf116
Remove indent for code surrounded by hidden code
Nilirad 5e1bac1
README docs breaks doctest suite
Nilirad b490df7
Apply suggestion
Nilirad bc6ef67
Unit `Bundle` is actually a thing
Nilirad ebbc6d2
Add newline after //! blocks on top of files
Nilirad 96ff662
Remove ECS crate level docs as done by #2575
Nilirad 50578d7
Add brief crate summary doc comment for `bevy_app`
Nilirad 637beb0
Merge branch 'main' of https://github.com/bevyengine/bevy into bevyen…
Nilirad 109c08f
Remove references to removed `WithBundle` filter
Nilirad 762be6c
Merge branch 'bevyengine-main' into api-docs-ch1
Nilirad 0136659
Merge branch 'main' into api-docs-ch1
Nilirad b5bb71a
Merge branch 'bevyengine:main' into api-docs-ch1
Nilirad 1e6a53e
Resolve merge conflicts
Nilirad 0997fe4
Merge branch 'bevyengine-main' into api-docs-ch1
Nilirad d740a96
fix
Nilirad 757aa22
Fix doc warnings
Nilirad 37b5b40
Resolve merge conflicts
Nilirad 49f8e3d
Merge branch 'bevyengine-main' into api-docs-ch1
Nilirad f0ef44c
Apply review suggestions, part 1
Nilirad 4c88e01
Move `.spawn().insert_bundle` alternative to `spawn`
Nilirad File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.