[
https://issues.apache.org/jira/browse/TINKERPOP-2119?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16729094#comment-16729094
]
ASF GitHub Bot commented on TINKERPOP-2119:
-------------------------------------------
FlorianHockmann commented on pull request #1025: TINKERPOP-2119 Add C# code
examples in doc as code
URL: https://github.com/apache/tinkerpop/pull/1025
https://issues.apache.org/jira/browse/TINKERPOP-2119
I moved most of the code examples from the docs into C# source files from
where they are now included in the docs. The examples are mostly added as
tests. Although I had to disable (`skip`) most of these tests for now as they
try to connect to a server running on `localhost:8182` where no server is
listening in our test environment. Nevertheless, this ensures even for these
disabled tests that the example code at least compiles and I could already find
some more errors in these examples.
We should from now one only add C# code examples to the docs by adding them
as source code and then including them in the AsciiDoc to ensure that our
examples in the docs always work and always match their respective version of
Gremlin.Net.
Only one C# code listing is still left directly in the docs as it includes
numbers as references which are then referenced in the text below (for the
lambda solution). We could of course replace these numbers simply by line
numbers, but I didn't want to do that for just one example as it would break
the style of the other examples.
I verified that the changes in the docs look as expected manually after
generating the docs with `docker/build.sh -d` and the .NET tests all pass.
VOTE +1
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Validate C# code samples in docs
> --------------------------------
>
> Key: TINKERPOP-2119
> URL: https://issues.apache.org/jira/browse/TINKERPOP-2119
> Project: TinkerPop
> Issue Type: Improvement
> Components: documentation, dotnet
> Affects Versions: 3.4.0
> Reporter: Florian Hockmann
> Assignee: Florian Hockmann
> Priority: Major
> Fix For: 3.4.0
>
>
> The docs now contain a lot of C# code samples (thanks for that, Stephen and
> Daniel). Unfortunately, some of these samples don't use proper C# syntax and
> therefore won't compile.
> Since I have already noticed in the past that some listings don't work any
> more with more recent versions of Gremlin.Net, we should not only correct
> these listings, but actually validate them automatically to ensure that we
> notice once the listings don't work any more.
> I limited the scope to C# here because I already noticed problems there, but
> this could of course also be done later for the other GLVs that can't be
> verified with the usual doc generation process.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
