Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Slightly misleading description of IsDeleted #5

Open
avelanarius opened this issue May 7, 2021 · 1 comment
Open

Slightly misleading description of IsDeleted #5

avelanarius opened this issue May 7, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@avelanarius
Copy link

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

@avelanarius
Copy link
Author

My try at documenting IsDeleted method in Java:

scylladb/scylla-cdc-java@c085d36

@piodul piodul self-assigned this May 7, 2021
@dkropachev dkropachev added the documentation Improvements or additions to documentation label Aug 17, 2024
@dkropachev dkropachev self-assigned this Aug 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants