[jira] [Commented] (TINKERPOP-1246) 'help' in the gremlin console should give the user something

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/TINKERPOP-1246?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15426297#comment-15426297 ] 

ASF GitHub Bot commented on TINKERPOP-1246:
-------------------------------------------

GitHub user robertdale opened a pull request:

    https://github.com/apache/tinkerpop/pull/383

    TINKERPOP-1246 Added help message to console

    Type ':help' or ':h' for help.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/robertdale/tinkerpop TINKERPOP-1246

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/tinkerpop/pull/383.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 #383
    
----
commit 3530d4612192659c6984d5428ddafb2b069f12f4
Author: Robert Dale <ro...@gmail.com>
Date:   2016-08-18T11:29:11Z

    added help message

----


> 'help' in the gremlin console should give the user something
> ------------------------------------------------------------
>
>                 Key: TINKERPOP-1246
>                 URL: https://issues.apache.org/jira/browse/TINKERPOP-1246
>             Project: TinkerPop
>          Issue Type: Improvement
>          Components: console
>    Affects Versions: 3.1.1-incubating
>            Reporter: Jeremy Hanna
>
> A new user to TinkerPop and/or Gremlin will probably flounder initially and will likely try to type 'help' in the gremlin-console.  Currently it just gives an error that help is not mapped to a class and gives the option to show a stack trace.
> I know there is :help for the command mode, but that's going to confuse them further I think because those are special commands and not what they're looking for.
> Piggy backing on something [~rustyrazorblade] mentioned, perhaps we could have it give a general message but help gremlin or help tinkerpop could open the docs.
> In general though, I think it would be useful to have something defined for help - perhaps a basic explanation with a couple of examples with the toy graph while also referring to the tutorials section of the site.  Then it would also be handy to override the help with specific commands like for each of the commands in the docs like traversal steps (though that may be a lot of work to maintain) such as 'help count' or 'help barrier'.  Specific keywords could be used like was mentioned 'help gremlin' or 'help tinkerpop' or 'help docs' could open the docs.
> Maybe some of this is overkill but I think overriding 'help' in some form would be helpful for new users.  Also just trying to brainstorm what could be done.



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