JanusGraph/janusgraph

Possible incosistency in chapter 5 documentation

Open

#1,573 opened on May 12, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Java (4,985 stars) (1,137 forks)batch import
good first issuehelp wanted

Description

In Chapter 5. Schema and Data Modeling first there is paragraph:

The default cardinality setting is SINGLE. Note, that property keys used on edges and properties have cardinality SINGLE. Attaching multiple values for a single key on an edge or property is not supported.

and then example:

mgmt = graph.openManagement()
follow = mgmt.makeEdgeLabel('follow').multiplicity(MULTI).make()
name = mgmt.makePropertyKey('name').dataType(String.class).cardinality(Cardinality.SET).make()
mgmt.addProperties(follow, name)
mgmt.commit()

doesn't this example contradict that edges can't have multiple values for a single key?

Contributor guide

Tech stack
java
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Java knowledgeJanusGraph graph schema concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Check the documentation source for Chapter 5 of the JanusGraph docs (likely in docs/ directory). Compare the paragraph about cardinality and the example with cardinality SET on an edge. Determine if the paragraph needs clarification or if the example is incorrect. Consider creating a PR to clarify the statement to avoid confusion for readers.