Stream: beginners

Topic: Error when running docs


view this post on Zulip Qqwy / Marten (Jun 19 2022 at 17:42):

I'm trying to run roc docs using cargo run docs.

But Roc hangs (on trunk ) with:

thread '<unnamed>' panicked at 'internal error: entered unreachable code: there is no shorthand named ""', compiler/load_internal/src/file.rs:2951:25
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

view this post on Zulip Qqwy / Marten (Jun 19 2022 at 17:42):

Am I doing something wrong or is this a bug?

view this post on Zulip Folkert de Vries (Jun 19 2022 at 17:44):

it needs a path right

view this post on Zulip Folkert de Vries (Jun 19 2022 at 17:45):

folkertdev@folkertdev ~/r/roc (trunk) [1]> cargo run docs
    Finished dev [unoptimized + debuginfo] target(s) in 0.22s
     Running `target/debug/roc docs`
── FILE NOT FOUND ──────────────────────────────────────────────── UNKNOWN.roc ─

I am looking for this file, but it's not there:

    /home/folkertdev/roc/roc/cli/tests/fixtures/format/formatted_directory/platform/Package-Config.roc

Is the file supposed to be there? Maybe there is a typo in the file
name?

is what I get

view this post on Zulip Qqwy / Marten (Jun 19 2022 at 17:46):

:thinking: I see... it is meant to build the docs of a project rather than of Roc's standard library?

view this post on Zulip Folkert de Vries (Jun 19 2022 at 18:18):

you can give it any roc file

view this post on Zulip Folkert de Vries (Jun 19 2022 at 18:18):

but documentation is usually for packages


Last updated: Jul 05 2025 at 12:14 UTC