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

chore: make function comments match function names #270

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dashangcun
Copy link

@dashangcun dashangcun commented Jan 9, 2025

This change is Reviewable

@@ -24,7 +24,7 @@ type filterCursor struct {
type filterChainIterator func(node *filterNode, forkPoint bool) bool

type filterChain interface {
// snapshots filter cursor of the latest node
// snapshotLatestCursor filter cursor of the latest node
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

snapshot?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think snapshotLatestCursor might be more appropriate.

What do you think? Do I need to roll back the changes here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean it should be a verb here to state the function of snapshotLatestCursor() method. Otherwise, it won't work semantically.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about changing it to snapshotLatestCursor returns the filter cursor of the latest node in the filter chain

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants