[TINKERPOP-1114] Documentation examples friendly for REPL/copy-paste

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Duplicate
• Affects Version/s: 3.1.0-incubating
• Component/s: documentation
• Assignee: Unassigned
• Reporter: Adam
• Created: 01/Feb/16 19:52
• Updated: 06/Oct/16 18:25
• Resolved: 06/Oct/16 18:25

Description

All code examples in existing documentation sometimes have "anchors" - numbers at the end of line which are explained later or create a kind of mapping between text and picture, e.g.

gremlin> marko.out('knows').values('name') (2)

The problem with them is that:
1) you need to edit such text if you want to paste it. You can't just paste a whole block to see what is the result in your console
2) at the first glance, it may look like additional list of parameters for whose who write in languages like Scala (curried function)

The simple way would be to separate them as comments
gremlin> marko.out('knows').values('name') // (2)

perhaps with any other more-specific visual way:
gremlin> marko.out('knows').values('name') // **2

Such change would make documentation more REPL - friendly and as everything that lowers entry barrier to such great project like this, may be worth your consideration.

I am happy to help with conversion / scripting that change if there will be go ahead for it.

Issue Links

• duplicates: TINKERPOP-1447 Add some JavaScript intelligence to the documentation so that comments and output are not copied in a copy paste