docs: fix typos in CLI help text and documentation - #302
Open
Avicennasis wants to merge 1 commit into
Open
Avicennasis wants to merge 1 commit into
Avicennasis wants to merge 1 commit into
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 6 small typos in CLI help text and command documentation. No functional changes - only
cobrahelp/usage strings and doc prose are touched.Namespaces API paths by prefixing it->...by prefixing them(the subject "API paths" is plural) - in both theShortandLongdescriptions.Eg. 2 API definitions->E.g. 2 API definitions- every othere.g.in the repo (openapitools/,deckformat/,docs/) is written with both periods.the path based namespace to apply->the path-based namespace to apply- matchespath-basedalready used at cmd/namespace.go:100 in the same file.When using '--selector' and '--values'->'--value'- the registered flag is--value(singular), as the preceding paragraph in the same help text already says.generation of entity id's->generation of entity IDs- plural, not possessive.No identifiers renamed, no test assertions affected (none of these strings are asserted in tests). Deliberately left alone: the repo's own
JSONpath/JSONpointer/JSONobjectspellings, which are consistent project-wide and are a maintainer style choice.