search

patriknw / akka-data-replication

Replication of CRDTs in Akka Cluster
Other
216 stars 18 forks source link

Rename the replicated data types #75

Closed patriknw closed 9 years ago

patriknw commented 9 years ago

I wonder if the current names are too technical for a broader audience, which doesn't care about the papers.

Here is one proposal:

Flag ->          ReplicatedFlag
GCounter ->      ReplicatedGrowOnlyCounter
GSet ->          ReplicatedGrowOnlySet
LWWMap ->        ReplicatedLastWriterWinsMap
LWWRegister ->   ReplicatedLastWriterWinsRegister
ORMap ->         ReplicatedMap
ORMultiMap ->    ReplicatedMultiMap
ORSet ->         ReplicatedSet
PNCounter ->     ReplicatedCounter
PNCounterMap ->  ReplicatedCounterMap

and here is another:

Flag ->          Flag
GCounter ->      GrowOnlyCounter
GSet ->          GrowOnlySet
LWWMap ->        LastWriterWinsMap
LWWRegister ->   LastWriterWinsRegister
ORMap ->         ReplicatedMap
ORMultiMap ->    ReplicatedMultiMap
ORSet ->         ReplicatedSet
PNCounter ->     Counter
PNCounterMap ->  CounterMap
patriknw commented 9 years ago

cc @hseeberger @huntc

hseeberger commented 9 years ago

I like the first one better, it's more consistent and expressive. Is it really last writer, not last write?

huntc commented 9 years ago

I personally don't have a problem with the existing names, and I feel that they are using a vocabulary that is familiar with this space.

patriknw commented 9 years ago

Thanks for your thoughts. I'm on the fence about this naming and wanted to start collecting some input, but I will defer decision.

I agree taht last write wins is probably better than last writer wins.

He-Pin commented 9 years ago

I think the current name is OK.

patriknw commented 9 years ago

thanks for input

He-Pin commented 9 years ago

I prefer current name cause we could quick match it with the resources you linked in the README,and the presentation/talk made by Mark Shapiro refers the same name too.

mhamrah commented 9 years ago

I agree with the current naming convention, and like @huntc they are consistent with the naming in the space. Although technical for a broader audience, have descriptive names like "Grow Only Counter" in the README will probably suffice people boarding, and point them in the right direction to understand more. Most likely simplifying a name within the framework isn't going to help a developer unwilling to understand CRDTs use a CRDT toolkit effectively, but examples/documentation will.

patriknw commented 9 years ago

Thanks guys. That is enough feedback for me to close this ticket without action.