Skip to content

Slightly misleading description of IsDeleted #5

Open
@avelanarius

Description

@avelanarius

The documentation for IsDeleted can be slightly misleading:

scylla-cdc-go/change.go

Lines 352 to 353 in 0bde107

// IsDeleted returns a boolean indicating if given column was set to null.
// This only works for clustering columns.

  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...)

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions