[GitHub] [tinkerpop] FlorianHockmann commented on issue #1025: TINKERPOP-2119 Add C# code examples in doc as code

["FlorianHockmann (GitHub)" <gi...@apache.org>]

I think the readability during authoring isn't that bad when you use a tool that can preview AsciiDoc like the [AsciiDoc plugin for VS Code](https://marketplace.visualstudio.com/items?itemName=joaompinto.asciidoctor-vscode) as it can directly include the code examples. So, at least in the preview, you won't notice the difference.
If we however find any other solution to verify the examples in the docs automatically, then we can of course also use that. I just think that we really need to verify them as they already contain errors and we currently don't really have many C# examples. If we want to add examples for the different GLVs for all steps, then this becomes a lot more important.

 > Do you feel like this needs to be merged for 3.4.0?

I would merge it for 3.4.0 simply because some examples in the docs had errors which are fixed by this. If you don't want to merge this now, then we could also compare the code examples included in source in this PR with the current version in the docs and fix them there independently of this PR for 3.4.0.

[ Full content available at: https://github.com/apache/tinkerpop/pull/1025 ]
This message was relayed via gitbox.apache.org for dev@tinkerpop.apache.org