akka/akka-core

Unclear doc of delta replication of ORMap

Open

#25,738 opened on Oct 4, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Scala (3,547 forks)batch import
1 - triagedhelp wantedt:distributed-data

Repository metrics

Stars
 (13,277 stars)
PR merge metrics
 (Avg merge 8d 19h) (10 merged PRs in 30d)

Description

The documentation paragraph about delta replication within this section does not seem clear to me.

Specifically: "Support for deltas here means that the ORSet being underlying key type for all those maps uses delta propagation to deliver updates. Effectively, the update for map is then a pair, consisting of delta for the ORSet being the key and full update for the respective value (ORSet, PNCounter or LWWRegister) kept in the map."

Some articles are missing, and "ORSet being underlying key type for all those maps" could gain to be moved earlier into a separate sentence that presents this implementation detail. (If I understood correctly)

Contributor guide

Research direction
Read the current documentation section about delta replication and rewrite the unclear paragraph to clearly explain that the ORSet key type uses delta propagation and that map updates consist of a delta for the key ORSet and a full update for the value.
Tech stack
scala
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80