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.

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

Docs are broken #23

Closed
janhohenheim opened this issue May 13, 2022 · 2 comments
Closed

Docs are broken #23

janhohenheim opened this issue May 13, 2022 · 2 comments
Labels
bug Something isn't working

Comments

@janhohenheim
Copy link

Describe the bug
The newest docs are broken

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://docs.rs/crate/bevy_ggrs/latest
  2. See error

Expected behavior
I see the newest docs

Screenshots
image

Desktop (please complete the following information):

  • OS: macOS
  • Browser [e.g. chrome, safari]: Firefox Nightly
  • Version [e.g. 22]: 101.0a1 (2022-04-29)

Additional context
Last working docs were 0.1.3

@janhohenheim janhohenheim added the bug Something isn't working label May 13, 2022
@gschup
Copy link
Owner

gschup commented May 13, 2022

Thanks for the report. Looking into the build logs on docs.rs, this seems to be a problem with bevy_ecs on nightly rust, which is used there.

[INFO] [stderr]     Checking bevy_ecs v0.6.0
[INFO] [stderr] error: format argument must be a string literal
[INFO] [stderr]    --> /opt/rustwide/cargo-home/registry/src/github.com-1ecc6299db9ec823/bevy_ecs-0.6.0/src/schedule/executor_parallel.rs:135:66
[INFO] [stderr]     |
[INFO] [stderr] 135 | ...                   .unwrap_or_else(|error| unreachable!(error));
[INFO] [stderr]     |                                                            ^^^^^
[INFO] [stderr]     |
[INFO] [stderr] help: you might be missing a string literal to format with
[INFO] [stderr]     |
[INFO] [stderr] 135 |                             .unwrap_or_else(|error| unreachable!("{}", error));
[INFO] [stderr]     |                                                                  +++++
[INFO] [stderr] 
[INFO] [stderr] error: format argument must be a string literal

If I run cargo doc --open locally, using stable rust, the docs build just fine. Small disclaimer: As it stands, bevy_ggrs does not have very good documentation. I recommend checking out the examples or the documentation of ggrs itself.

@gschup
Copy link
Owner

gschup commented Aug 19, 2022

While I was unable to resolve the issue for 0.9, bevy_ggrs 0.10 has built docs on docs.rs.

@gschup gschup closed this as completed Aug 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants