docs: fix 17 typos in comments and log messages - #67
Open
Avicennasis wants to merge 1 commit into
Open
Conversation
Spelling and grammar fixes in doc comments, plus two log message strings in lock/lock.go. Also corrects four stale 'Terrablob' references in pipe/s3.go and two copy-pasted 'mysql' references in util/util.go doc comments that describe the Postgres and ClickHouse converters. No functional changes; the only non-comment edits are the wording of two Errorf strings, which nothing asserts on.
ovaistariq
approved these changes
Sep 3, 2026
efirs
approved these changes
Sep 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes 17 typos in comments and two log-message strings. No functional changes.
util/util.go// PostgresToDriverType converts mysql type names ...->converts Postgres type names ...- the function switches onint2/int4/float4/numeric/varchar/bool, which are Postgres type names.// ClickHouseToDriverType converts mysql type names ...->converts ClickHouse type names ...- the function switches onint8..int64/uint8../float32/fixedstring, which are ClickHouse type names.//QueryRowSQL executes SQL query which return single row->which returns single row(same forQueryTxRowSQL)//MySQLError checks if givens error is ...->if given error is ...// SortedGTIDString ... where UUIDs comes in->where UUIDs come inpipe/s3.goFour doc comments still refer to
Terrablob, but everything in the file is the S3 pipe (s3Pipe,s3Client,s3Consumer) andType()returns"s3":// s3Consumer consumes messages from Terrablob ...->from S3 ...// Type returns Pipe type as Terrablob->as S3//NewProducer registers a new Terrablob producer->a new S3 producer//NewConsumer registers a new Terrablob consumer->a new S3 consumerlock/lock.go// is already held then TryLock is noop.->then TryLockShared is noop.onTryLockShared- the doc block was copy-pasted fromTryLockand still names the wrong method.Errorf("Lock did not exists on release")->"Lock did not exist on release"Errorf("Lock was not hold by me")->"Lock was not held by me"streamer/buffer.go// Its time to commit the batch->// It's time to commit the batch//Guarantee that we can loose no more than ...->we can lose no more than ...// log.Debugf("commont format received ...->"common format received ...(commented-out debug line;CommonFormatEventis the type involved)log/log.go//def is a instance of default logger->//def is an instance of default loggerNote for reviewers
Two of these edits are inside Go string literals rather than comments (the
Errorfmessages inlock/lock.go). They are the only occurrences of those strings in the repository - nothing asserts on them - but flagging so you can review deliberately. Everything else is comment-only.