You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tinkerpop.apache.org by dkuppitz <gi...@git.apache.org> on 2017/08/16 18:13:37 UTC
[GitHub] tinkerpop pull request #694: TINKERPOP-1748 Callout comments break code snip...
GitHub user dkuppitz opened a pull request:
https://github.com/apache/tinkerpop/pull/694
TINKERPOP-1748 Callout comments break code snippets
https://issues.apache.org/jira/browse/TINKERPOP-1748
Made callouts in docs prettier and copy+paste friendly.
Tested with `docker/build.sh -d`. Looks great and all snippets can now be pasted into the console w/o producing any syntax errors due to callout comments.
VOTE: +1
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/apache/tinkerpop TINKERPOP-1748
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/tinkerpop/pull/694.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #694
----
commit 42f3a91b086e929340bb10641f9ffc32b0db0b71
Author: Daniel Kuppitz <da...@hotmail.com>
Date: 2017-08-16T18:06:55Z
Made callouts in docs prettier and copy+paste friendly.
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] tinkerpop issue #694: TINKERPOP-1748 Callout comments break code snippets
Posted by dkuppitz <gi...@git.apache.org>.
Github user dkuppitz commented on the issue:
https://github.com/apache/tinkerpop/pull/694
Well, this PR only tackles the callout comments. Any other comment would still break copy+paste. However, the cool thing about this solution is, that it doesn't involve JavaScript, only a minor CSS tweak.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] tinkerpop pull request #694: TINKERPOP-1748 Callout comments break code snip...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/tinkerpop/pull/694
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] tinkerpop issue #694: TINKERPOP-1748 Callout comments break code snippets
Posted by dkuppitz <gi...@git.apache.org>.
Github user dkuppitz commented on the issue:
https://github.com/apache/tinkerpop/pull/694
Static code blocks are now clean too.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] tinkerpop issue #694: TINKERPOP-1748 Callout comments break code snippets
Posted by robertdale <gi...@git.apache.org>.
Github user robertdale commented on the issue:
https://github.com/apache/tinkerpop/pull/694
VOTE +1
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] tinkerpop issue #694: TINKERPOP-1748 Callout comments break code snippets
Posted by dkuppitz <gi...@git.apache.org>.
Github user dkuppitz commented on the issue:
https://github.com/apache/tinkerpop/pull/694
Huh, interesting, these are static / non-evaluated code blocks. I will check why they were not affected.
> Then there's still the issue where comments inline of a multi-line command doesn't work in groovy console.
This is only true for the static blocks, right? I've tried a few snippets from evaluated code blocks (single- and multi-line) and they all worked.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] tinkerpop issue #694: TINKERPOP-1748 Callout comments break code snippets
Posted by robertdale <gi...@git.apache.org>.
Github user robertdale commented on the issue:
https://github.com/apache/tinkerpop/pull/694
Looks like it works for some but not all.
The very first one on the reference page didn't work:
Graph graph = TinkerGraph.open(); (1)
Looks like there are ones with circles and have the round brackets which don't work.
Then there are the ones with circles without round brackets which do work.
Then there's still the issue where comments inline of a multi-line command doesn't work in groovy console.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] tinkerpop issue #694: TINKERPOP-1748 Callout comments break code snippets
Posted by spmallette <gi...@git.apache.org>.
Github user spmallette commented on the issue:
https://github.com/apache/tinkerpop/pull/694
This looks good - does this basically allow us to close:
https://issues.apache.org/jira/browse/TINKERPOP-1447
It doesn't do everything that ticket says, but that's about as good as we're going to get I would imagine, right?
VOTE +1
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] tinkerpop issue #694: TINKERPOP-1748 Callout comments break code snippets
Posted by robertdale <gi...@git.apache.org>.
Github user robertdale commented on the issue:
https://github.com/apache/tinkerpop/pull/694
Ah, I see now. You've added line continuations `\` on the mid-traversals. Excellent.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---