Skip to content

ponytest example code should use \nodoc\ #495

@SeanTAllen

Description

@SeanTAllen

I believe that demonstrating "code best practices" is a general ideal for the tutorial. With the caveat of "unless it blurs the point".

I think in the case of the example code in ponytest section that adding \nodoc\ to the test code as we have throughout the standard library and various ponylang libraries makes sense in that, it shouldn't obscure the meaning of the code and helps enforce the existence of the annotation.

The one drawback to this right now is that non of the syntax highlighters we use understand annotations and as such, syntax highlighting will be broken.

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions