Stream: bugs

Topic: roc docs bad reference to [Str] inside opaque type

Aurélien Geron (Jun 29 2026 at 13:29):

I'm trying to generate the docs for the updated roc-parser library, using roc docs. The code looks like this:

#package/String.roc
String :: {}.{
    Utf8 : List(U8)

    # # Parse a [Str] using a [Parser]
    parse_str : ...
    ...

    ## Matches any [Utf8] and consumes all the input without fail.
    any_thing : ...
    ...
}

But I get the following errors when I run roc docs package/main.roc:

Error: 5 doc reference(s) point at non-existent anchors:
  [...]/roc-parser/package/String.roc:10: [Str] -> #String.Str
  [...]/roc-parser/roc-parser/package/String.roc:195: [Utf8] -> #String.String.Utf8
  [...]

Should I file a bug or am I missing a command line option or something?

Anton (Jun 29 2026 at 13:56):

Yes, this is a bug, those html links that would be generated in the docs would probably not work, which is why it's erroring out.

Last updated: Jul 23 2026 at 13:15 UTC