[jira] [Commented] (TINKERPOP-3018) No Syntax Highlighting for .NET Examples

["Florian Hockmann (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/TINKERPOP-3018?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17788679#comment-17788679 ] 

Florian Hockmann commented on TINKERPOP-3018:
---------------------------------------------

Some C# examples however have at least basic syntax highlighting: https://tinkerpop.apache.org/docs/current/reference/#gremlin-dotnet-connecting

One difference between examples for C# and the other languages is that we include (most of) the C# [code examples from C# source files|https://github.com/apache/tinkerpop/blob/master/docs/src/reference/intro.asciidoc#gremlin-server]:

{code}
link:../../../gremlin-dotnet/test/Gremlin.Net.IntegrationTest/Docs/Reference/IntroTests.cs[]
{code}

I wonder whether the combination of including the code examples and using the tabs features to display examples for different languages together results in getting no syntax highlighting.

In general, I implemented this approach to include code examples in the docs from source files to ensure that the examples continue to actually work, or at least still compile, despite changes we make in some Gremlin steps or in the .NET GLV. However, it's of course inconsistent to only to do this for Gremlin.NET but not for the other GLVs, therefore adds complexity for contributors and I don't know of any problems that we actually caught because of this approach.
So, I'm also open to moving away from this approach and directly including the C# examples in the asciidoc files.

> No Syntax Highlighting for .NET Examples
> ----------------------------------------
>
>                 Key: TINKERPOP-3018
>                 URL: https://issues.apache.org/jira/browse/TINKERPOP-3018
>             Project: TinkerPop
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 3.6.5
>            Reporter: Cole Greer
>            Priority: Minor
>
> In the reference docs, the C# code examples have no syntax highlighting. The code examples for all other GLV's have such highlighting. This can be seen in the examples here: https://tinkerpop.apache.org/docs/3.6.5/reference/#basic-gremlin.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)