fix(docs): correct typos and improve clarity in v3 documentation#2341
Open
napoleonbot wants to merge 1 commit into
Open
fix(docs): correct typos and improve clarity in v3 documentation#2341napoleonbot wants to merge 1 commit into
napoleonbot wants to merge 1 commit into
Conversation
- Fix 'Cli.Command' -> 'cli.Command' in v2-to-v3 migration guide - Add missing colon after '2 arguments' in handler signatures section - Fix 'is need' -> 'is needed' in timestamp flag docs - Fix 'most flag' -> 'most flags' in flags basics - Fix 'was default to' -> 'defaulted to' in flags basics - Fix 'lets' -> 'let's' in flags basics - Fix broken reference to 'flags-advanced.md' -> proper markdown link - Fix extraneous space before period in timestamp flag section - Improve sentence clarity: 'gives a lot of outputs' -> 'gives different outputs' - Fix triple backticks to single backticks for inline code reference
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
This PR fixes several typos and clarity issues in the v3 documentation:
Migration Guide (v2 → v3)
Cli.Command→cli.Commandin the Handler Function Signatures section. The uppercaseCliis incorrect and could confuse readers.2 arguments a→2 arguments: afor proper punctuation.Flags Basics (v3/examples/flags/basics.md)
is need→is needed(grammar fix in timestamp flag section)most flag→most flags(plural agreement)was default to→defaulted to(correct verb form)lets change→let's change(missing apostrophe)flags-advanced.mdwith a proper markdown link[advanced flags](advanced.md)gives a lot of outputs→gives different outputs(clearer phrasing)All changes are documentation-only and do not affect any code behavior.
Contributed by Sediman — AI-powered video ads in seconds