[
https://issues.apache.org/jira/browse/TINKERPOP-1246?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15426680#comment-15426680
]
ASF GitHub Bot commented on TINKERPOP-1246:
-------------------------------------------
Github user PommeVerte commented on the issue:
https://github.com/apache/tinkerpop/pull/383
I'm personally ok with the concept. It seems pretty mainstream and will
definitely help some folk. It's the kind of thing that you don't really pick up
from reading the documentation (at least I don't) I know it's there from
keeping up with the mailing list but otherwise I wouldn't have a clue.
> '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)
