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

Jump to bottom

Documentation warnings #2576

Closed
Hoidigan opened this issue Jul 31, 2021 · 0 comments
Closed

Documentation warnings #2576

Hoidigan opened this issue Jul 31, 2021 · 0 comments
Labels
C-Docs An addition or correction to our documentation

Comments

@Hoidigan
Copy link
Contributor

How can Bevy's documentation be improved?

There are various warnings when building documentation for the bevy crates.

Going through the list:
bevy_app:

  • FromResources does not exist (nor does it exist in any other crate, I believe). I think this one is from a refactoring to FromWorld.
  • WinitPlugin, DefaultPlugins, and MinimalPlugins are all missing because they are in different crates.

bevy_ecs:

  • broken links for Bundle::component_id (type of component_ids?)
  • broken link SystemParam (not imported, needs full path).

bevy_pbr and bevy_asset both have bare urls that should be surrounded with <>.
The urls are an easy fix (assuming we want to make them clickable?)

For the refactoring and typos, if that is what those are, that should be easy to fix as well.

The rest of the crates give no errors, so good there.

The different crate plugins are referenced from bevy_app, but are in bevy_internal, which poses an issue.
@Hoidigan Hoidigan added C-Docs An addition or correction to our documentation S-Needs-Triage This issue needs to be labelled labels Jul 31, 2021
@Hoidigan Hoidigan mentioned this issue Jul 31, 2021
Closed
@Davier Davier mentioned this issue Aug 5, 2021
Closed
@NiklasEi NiklasEi removed the S-Needs-Triage This issue needs to be labelled label Aug 6, 2021
bors bot pushed a commit that referenced this issue Aug 13, 2021
@Davier
Cleanup FromResources (#2601)
6aedb25 
## Objective

- Clean up remaining references to the trait `FromResources`, which was replaced in favor of `FromWorld` during the ECS rework.

## Solution

- Remove the derive macro for `FromResources`
- Change doc references of `FromResources` to `FromWorld`

(this is the first item in #2576)
bors bot pushed a commit that referenced this issue Sep 14, 2021
@Hoidigan
Doc warnings (#2577)
663dedf 
Fixes #2576 

Add <> to links where needed, fix typo and refactored names, and add docs.rs links for external items.
@bors bors bot closed this as completed in 34f0085 Sep 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-Docs An addition or correction to our documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Merged by Bors] - Doc warnings Hoidigan/bevy
2 participants
@NiklasEi @Hoidigan