spmallette commented on code in PR #3483: URL: https://github.com/apache/tinkerpop/pull/3483#discussion_r3494310321
########## docs/src/reference/the-traversal.asciidoc: ########## @@ -640,6 +640,33 @@ link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gre link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#addV(java.lang.String)++[`addV(String)`], link:++https://tinkerpop.apache.org/javadocs/x.y.z/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#addV(org.apache.tinkerpop.gremlin.process.traversal.Traversal)++[`addV(Traversal)`] +[[addlabel-step]] +=== AddLabel Step + +The `addLabel()`-step (*sideEffect*) adds one or more labels to an element. The graph must be configured with a +`LabelCardinality` that supports mutation (e.g. `ZERO_OR_MORE` or `ONE_OR_MORE`). Adding a label that already exists +on the element is a no-op. + +[gremlin-groovy] +---- +conf = new BaseConfiguration() +conf.setProperty("gremlin.tinkergraph.vertexLabelCardinality", "ZERO_OR_MORE") +graph = TinkerGraph.open(conf) +g = traversal().with(graph) +g.addV('person').property('name','marko').addLabel('employee').labels() +g.V().has('name','marko').hasLabel('person') +g.V().has('name','marko').hasLabel('employee') +---- + +NOTE: When `LabelCardinality` is set to `ONE` (the default), calling `addLabel()` will throw an +`IllegalStateException` since labels are immutable in that mode. + +See: <<labels-step,labels() step>>, <<droplabel-step,dropLabel() step>> Review Comment: "See:"? that doesn't belong in the Reference Docs. I mean, it's an interesting idea to reference other related steps, but not sure now is the time to introduce things like that. Please remove in the other newly added step content too. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
