You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It can also be seen that the Python-highlighted code block has different margins.
Further, when using indentation to indicate code, according to the Google format, there is no way to specify syntax highlighting at all. It is off. E.g.:
deftest():
""" A docstring in Google format. Here is a code block: # This example code can't be syntax-highlighted foo = bar """
Proposal
Since this project is intended for Python, it would make sense for all code blocks to be syntax highlighted by default.
It would also make sense for margins to be consistent.
But most importantly, when using indentation to indicate code in the Google format, it seems most important to syntax highlight by default, since there isn't any way of enabling it manually, the way it can be done with Markdown.
Also, if there are markdown code blocks that shouldn't have highlighting (e.g. terminal output), one solution could be to specify them as text, a language code supported on GitHub
Alternatives
If syntax highlighting isn't enabled by default for Markdown, to do it at least for Google-style indented code.
The text was updated successfully, but these errors were encountered:
Problem Description
Code blocks are not syntax-highlighted in Python by default. For example, compare:
This generates:
It can also be seen that the Python-highlighted code block has different margins.
Further, when using indentation to indicate code, according to the Google format, there is no way to specify syntax highlighting at all. It is off. E.g.:
Proposal
Since this project is intended for Python, it would make sense for all code blocks to be syntax highlighted by default.
It would also make sense for margins to be consistent.
But most importantly, when using indentation to indicate code in the Google format, it seems most important to syntax highlight by default, since there isn't any way of enabling it manually, the way it can be done with Markdown.
Also, if there are markdown code blocks that shouldn't have highlighting (e.g. terminal output), one solution could be to specify them as
text
, a language code supported on GitHubAlternatives
If syntax highlighting isn't enabled by default for Markdown, to do it at least for Google-style indented code.
The text was updated successfully, but these errors were encountered: