[
https://issues.apache.org/jira/browse/TINKERPOP3-678?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14717108#comment-14717108
]
Matt Frantz commented on TINKERPOP3-678:
----------------------------------------
It is appropriate to have open tickets for technical debt with clearly defined
boundaries, e.g. Javadocs for all of {{GraphTraversal}},
{{GraphTraversalSource}}, and {{__}}. That would help application writers a
lot.
The next tier is for vendors, so perhaps a second issue with clearly defined
goals for documenting certain {{Step}} classes would be appropriate.
> Javadoc for Base Steps
> ----------------------
>
> Key: TINKERPOP3-678
> URL: https://issues.apache.org/jira/browse/TINKERPOP3-678
> Project: TinkerPop 3
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 3.0.0-incubating
> Reporter: stephen mallette
> Assignee: Marko A. Rodriguez
> Priority: Minor
>
> Provide javadoc for all of the "base steps" such as:
> * {{CollectingBarrierStep}}
> * {{ComputerAwareStep}}
> * {{ReducingBarrierStep}}
> * others....
> For those writing custom steps (or debugging existing ones), it will be
> helpful to understand the nature of these base steps, when they should be
> used, what their implications are to a traversal, etc. In short, choosing
> the right one is important.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
