My answer wasn't great - let me add a little more.  I don't think we should
generally go to naming TraversalSource as "ts" because the name you give to
this variable should generally be representative of the context of the
TraversalSource itself.  This ultimately ties all the way up to Gremlin
Server in how you reference the TraversalSource you want to refer to and
there are multiple TraversalSource objects at play.  We need to continue to
convey to folks that they should think of "g" as a default name when you
have a single source configured.  I know that might not eliminate the
initial confusion for folks, but I think we've discussed the naming of "g"
before and that any initial confusion should probably be short-lived.

+1 for a CAUTION: as suggested by Marko.

On Mon, Sep 28, 2015 at 3:00 PM, Marko Rodriguez <[email protected]>
wrote:

> Hi,
>
> Bryn: you could provide a pull request for some sort of blockquote that
> explains the distinction so it makes it easier for the community (as a
> permeating entity across all space and time) to know whats going on.
>
> E.g.
>
>         CAUTION: In TinkerPop3, `g`….in TinkerPop3…
>
> Marko.
>
> http://markorodriguez.com
>
> On Sep 28, 2015, at 12:56 PM, Stephen Mallette <[email protected]>
> wrote:
>
> > I dunno, Bryn.  I kinda get your point, but:
> >
> > ts.V()
> >
> > looks so wrong - however:
> >
> > g.V()
> >
> > ahhh - all is right with the universe. :D
> >
> >
> >
> > On Mon, Sep 28, 2015 at 2:50 PM, Bryn Cooke <[email protected]> wrote:
> >
> >> Hi Tinkerpop,
> >>
> >> I have fielded a couple of questions from some new Tinkerpop 3 users
> >> recently and wonder if a slight tweak to the docs could make things
> easier
> >> for those coming from TP2.
> >>
> >> g = graph.traversal(standard())
> >>
> >> For TP2 users this line is easy to miss, many people will just skim the
> >> docs rather than read them from start to finish.
> >> This is compounded by the fact that g was used as the 'graph' variable
> in
> >> TP2 docs. The solution:
> >>
> >> ts = graph.traversal(standard())
> >>
> >> The object is a traversal source anyway, so calling it 'g' makes no
> sense
> >> even for new TP users.
> >>
> >> Cheers,
> >> Bryn
> >>
> >>
>
>

Reply via email to