docs: fix typos in code comments and doc strings - #186
Open
Avicennasis wants to merge 1 commit into
Open
Conversation
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 23 typos in Go doc comments and one copyright header. Comments only - no code, no identifiers, no behaviour change.
rocksdb/backup.goGetCount gets the number backsup available->the number of backups available// GetSize get the size ...->gets// Close close the backup engine ...->closesrocksdb/write_batch.go// NewWriteBatch create a WriteBatch object.->creates// NewNativeWriteBatch create a WriteBatch object.->creates// Destroy destroys de LogDataExtractor.->the LogDataExtractorlog/logger.gohightest possible rank->highest(e.g. losts of contact with peers...)->loss of contactmessages that hightlight the main progress->highlightTrace designates a even finer-grained informational events->designates even finer-grained informational events(matches the wording of theDebugentry just above)Any log trace less sever is supressed.->less severe is suppressedIf set, this override InferLevels.->overridesclient/config.gosome amount of dely between event replication->delaythe time the healtch checker waits for->health checkerhelthchecks of all endpoints->healthchecks(both the doc comment and thedesc:flag description, so the CLI help text matches)balloon/hyper/tree.goa sparse merkel tree->Merkle(the spelling used indocs/source/internals/glossary.rstand indocs/source/spelling_wordlist.txt)verify a membersip proof->membershipballoon/hyper/batch_cache.goThis comes from the intuituion that->intuition4 -3->4 - 3(aligns the=with the other three rows),2 bits => indexes 0..4->0..3, and3 bits => indexes 0..7(was0..8) - 2 bits address 4 indexes and 3 bits address 8, so the ranges were off by onecrypto/hashing/hash.godifferent hashers and their funcionality->functionalitycmd/agent_auditor.goBanco Bilbao Vizcaya Argentaria, n.A.->S.A.(223 other files in the repo sayS.A.)Note: the same
n.A.header typo also appears incrypto/keys.go,cmd/agent_monitor.goandcmd/agent_publisher.go, andmerkelalso appears inballoon/history/tree.go. Those were outside the scope of this pass - happy to include them if you would prefer one sweep.No functional changes - comments and documentation only.