pony-tutorial icon indicating copy to clipboard operation
pony-tutorial copied to clipboard

ponytest example code should use \nodoc\

Open SeanTAllen opened this issue 3 years ago • 2 comments

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.

SeanTAllen avatar Feb 02 '22 22:02 SeanTAllen

My preference as expressed in the sync call, is that I think we should fix the syntax highlighter that renders the tutorial before updating the tutorial

jemc avatar Mar 08 '22 19:03 jemc

Here's the pygments lexer for Pony which needs to be updated: https://github.com/pygments/pygments/blob/master/pygments/lexers/pony.py

jemc avatar May 10 '22 18:05 jemc