Skip to content

Fix inconsistency between doc comments and actual type/function names #638

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.

Sign up for GitHub

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

Merged
roger2hk merged 1 commit into from
May 12, 2025
Merged

Fix inconsistency between doc comments and actual type/function names #638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api/layout/paths.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ func fmtN(N uint64) string {
return n
}

// ParseTileLevelIndexWidth takes level and index in string, validates and returns the level, index and width in uint64.
// ParseTileLevelIndexPartial takes level and index in string, validates and returns the level, index and width in uint64.
//
// Examples:
// "/tile/0/x001/x234/067" means level 0 and index 1234067 of a full tile.
Expand Down
2 changes: 1 addition & 1 deletion append_lifecycle.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ func init() {

}

// Add adds a new entry to be sequenced.
// AddFn adds a new entry to be sequenced.
// This method quickly returns an IndexFuture, which will return the index assigned
// to the new leaf. Until this index is obtained from the future, the leaf is not durably
// added to the log, and terminating the process may lead to this leaf being lost.
Expand Down
4 changes: 2 additions & 2 deletions internal/hammer/loadtest/workers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ func (r *LeafReader) getLeaf(ctx context.Context, i uint64, logSize uint64) ([]b
return r.c.leaves[ti], nil
}

// Kills this leaf reader at the next opportune moment.
// Kill kills this leaf reader at the next opportune moment.
// This function may return before the reader is dead.
func (r *LeafReader) Kill() {
if r.cancel != nil {
Expand Down Expand Up @@ -224,7 +224,7 @@ func (w *LogWriter) Run(ctx context.Context) {
}
}

// Kills this writer at the next opportune moment.
// Kill kills this writer at the next opportune moment.
// This function may return before the writer is dead.
func (w *LogWriter) Kill() {
if w.cancel != nil {
Expand Down
Loading