Coder Social home page Coder Social logo

Docs are broken about bevy_ggrs HOT 2 CLOSED

gschup avatar gschup commented on June 23, 2024
Docs are broken

from bevy_ggrs.

Comments (2)

gschup avatar gschup commented on June 23, 2024

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.

from bevy_ggrs.

gschup avatar gschup commented on June 23, 2024

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

from bevy_ggrs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.