Stream: beginners

Topic: How roc docs


view this post on Zulip Johan Lövgren (Dec 12 2023 at 19:48):

How does roc docs work? I am trying to generate docs for a package I am creating, but only the types is showing up in the docs, not the content of the doc-comments. Is there something I am missing? See e.g. my file https://github.com/Subtlesplendor/roc-data/blob/main/package/Stack.roc
with the docs
https://subtlesplendor.github.io/roc-data/Stack/

view this post on Zulip Luke Boswell (Dec 12 2023 at 20:32):

I think you need 1 space after the ## before your content

view this post on Zulip Luke Boswell (Dec 12 2023 at 20:32):

Otherwise looks good to me

view this post on Zulip Luke Boswell (Dec 12 2023 at 20:33):

Definitely should provide an error or something more helpful if this is the issue.

view this post on Zulip Johan Lövgren (Dec 12 2023 at 20:33):

Oh I see, thanks! Will try that

view this post on Zulip Luke Boswell (Dec 12 2023 at 20:34):

In some places you have this, but there is usually a line that doesn't and that must confuse the parser or something.

view this post on Zulip Johan Lövgren (Dec 12 2023 at 20:55):

Yes thanks now it works! :D


Last updated: Jul 05 2025 at 12:14 UTC