[jira] [Closed] (TINKERPOP-1114) Documentation examples friendly for REPL/copy-paste

["stephen mallette (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/TINKERPOP-1114?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

stephen mallette closed TINKERPOP-1114.
---------------------------------------
    Resolution: Duplicate

> Documentation examples friendly for REPL/copy-paste
> ---------------------------------------------------
>
>                 Key: TINKERPOP-1114
>                 URL: https://issues.apache.org/jira/browse/TINKERPOP-1114
>             Project: TinkerPop
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 3.1.0-incubating
>            Reporter: Adam
>            Priority: Minor
>
> 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.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)