search

scylladb / scylla-cdc-go

Apache License 2.0
43 stars 11 forks source link

Slightly misleading description of IsDeleted #5

Open avelanarius opened 3 years ago

avelanarius commented 3 years ago

The documentation for IsDeleted can be slightly misleading:

https://github.com/scylladb/scylla-cdc-go/blob/0bde107ec413ece918ebd6f309bad4cd5e25bf8d/change.go#L352-L353

  1. "This only works for clustering columns." - clustering columns of the base table
  2. "boolean indicating if given column was set to null" - in non-frozen collections, IsDeleted=true means that a collection was overwritten, not necessarily set to null.

(I'm in process of writing the same docstring for a corresponding method in Java library and also having difficulty to word it properly - succinctly, but remembering all those corner cases...)

avelanarius commented 3 years ago

My try at documenting IsDeleted method in Java:

https://github.com/scylladb/scylla-cdc-java/pull/51/commits/c085d362ea367cb952a601eeab516ff7d23a3f13