docs: fix typos in comments and documentation - #81
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
2 participants
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 spelling/grammar defects in KDoc comments, inline comments, CLI help text and Markdown docs. No logic changes.
Subject-verb agreement on the config-file description (same sentence, copy-pasted into five places)
A yaml file that describe a set of files->describes@param config a yaml file that describe a set of files->describes@param config a yaml file that describe a set of files->describespath to a yaml file that describe a set of files->describes--helpoutput carries the same sentence, updated so it still matches the CLIOther typos in comments / KDoc
override the same value in config is they are defined->if they are definedSince we have th repo already->the repodirectories to files and file to revisions ... included file that we want->files to revisions ... included files that we want(parallel plurals)@param filename to path to save to.->@param filename the path to save to.An boolean->A booleanAdditionally noticed (not in the original report, found while reading the surrounding files)
A model fof the schema attribute->A model for the schema attributein the resulted saved config file->in the resulting saved config filea flat map or a nest map->a flat map or a nested map(the--flat-fileshelp text and its mirror in the README)at the root fo the remote repo->of;unneccesary->unnecessary;the sames ones we were using->the same ones;including pre-build artifacts->pre-built(matches "pre-built and published artifacts" earlier in the same file);a few files from large remote monorepo->from a large remote monorepoincluded file that we want->included files that we want(same sentence as the GitQueryConfig KDoc)This examples shows how to generate->This example showsNotes for review
--config-fileand--flat-files), so they do change whatgitquery --helpprints. The README contains a pasted copy of that help output, and it has been updated in the same commit so the two stay byte-identical.buildSrc/src/main/kotlin/utlils.ktis misspelled, but renaming a file is out of scope for a typo fix.samples/sample2-generate-{flat,nested}.ymlare generated YAML dumps,samples/.../AddressBookProtos.javais protobuf output, and the LICENSE header is untouched.gradle-plugin/.../GitQueryInitExtension.ktinitialisesexcludeGlobsfromdefaultIncludeGlobsrather thandefaultExcludeGlobs, which looks like a copy-paste slip. That would be a behaviour change, so it is not part of this PR - flagging it in case it is a real bug.No functional changes beyond the two CLI help strings noted above.