Skip to content

[Feat] loosen up doc-string syntax #2113

@BWindey

Description

@BWindey

Currently it is not possible to split the expression and/or description of @param, @return and @require over multiple lines.

It would be great if we could do something like:

<*
    @require arg1 <= 0 && arg2 >= 0 : 
        "This function requires arg1 to be negative, and arg2 to be positive"
*>

A more complex example:

<*
    @require argument_1 & 0b1110_0000 == 0b1100_0000
        || argument_2 & 0b1100_0000 == 0b0100_0000 
        : "argument_1 should point to start of UTF8 2-byte character "
          "or argument_2 should point to start of UTF8 1-byte character"
*>

I don't know how much freedom would be possible while staying with C3s goals, but it would be great if this could be looked into.

Metadata

Metadata

Assignees

Labels

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions