Stream: beginners

Topic: Doc comment syntax

view this post on Zulip Eli Dowling (Mar 10 2024 at 09:51):

I've noticed that:

##This is not a valid doc comment
User:{name:Str}

## This is a valid doc comment
User:{name:Str}

Is it intentional for comments with ## but without a starting space to not be treated as doc comments?

view this post on Zulip Jonas Schell (Mar 10 2024 at 10:09):

I know that roc format converts #comment to # comment by adding a space. Maybe this should also happen for ##comment?

view this post on Zulip Anton (Mar 12 2024 at 12:38):

Good suggestion, I've written this up in #6582

Last updated: Nov 09 2025 at 12:14 UTC