Jeremy Hanna created TINKERPOP-1246:
---------------------------------------
Summary: '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: Bug
Components: console
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)
