-
-
Notifications
You must be signed in to change notification settings - Fork 111
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ponytest example code should use \nodoc\ #495
Labels
help wanted
Extra attention is needed
Comments
github-actions
bot
added
the
discuss during sync
Should be discussed during an upcoming sync
label
Feb 2, 2022
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 |
SeanTAllen
removed
needs discussion
Needs to be discussed further
discuss during sync
Should be discussed during an upcoming sync
labels
May 10, 2022
Here's the pygments lexer for Pony which needs to be updated: https://github.com/pygments/pygments/blob/master/pygments/lexers/pony.py |
ponylang-main
added
the
discuss during sync
Should be discussed during an upcoming sync
label
May 10, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The text was updated successfully, but these errors were encountered: