docs: fix 21 typos in comments and documentation - #190
Open
Avicennasis wants to merge 1 commit into
Open
Conversation
Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
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
Fix 21 typos in Go comments, doc comments and one error string across 7 files.
an existed dir->an existing dir;an exist file->an existing file;// Containe checks->// Contain checks(doc comment now matches the realContainfunc);automaticly->automatically;signed data an a public key->and a public key;decryptes->decrypts//GetTags return tas data->//GetTags returns tag datathe Artifcat V1 object->the Artifact V1 objectchecks if a protocal is->checks if a protocol is(theprotocalparameter andappV1Protocalconst are left alone - renaming identifiers is out of scope)an UpdateServceStorage interface with a local implmentation->an UpdateServiceStorage interface with a local implementation(doc comment now matches the realUpdateServiceStorageinterface);namespace/repositoryi/os/arch/appname->namespace/repository/os/arch/appnameplugin use after->plugin uses after;'appv1',calling->'appv1', calling; secondone is group snapshot->another is group snapshot;encrytped->encrypted;TODO: Better structed->TODO: Better structureddeamon->daemonin four commentsTwo notes for reviewers:
updateservice/storage/local.gothe error text"invalid key deteced in StorageLocal.List"becomes"invalid key detected in StorageLocal.List". The other six sibling errors in that same file already saydetected, so this makes the set consistent. Nothing in the repo asserts on this string (greppedtests/), but please confirm no downstream log parsing depends on it.cmd/daemon.gohad a fourthdeamon(in themonitorDaemondoc comment) that was not in the original report; it is fixed too, since leaving one misspelling of the same word in the same file would be arbitrary.No identifiers were renamed and no behaviour changes:
GetPackageRESTV1Hanfdler,DeletePacakgeRESTV1Handler,appV1Protocal,monitorDeamonCmdandstartDeamonare all left exactly as they are, because their doc comments must keep matching the declared names.Commit is DCO signed-off per the Contributing section of the README.