docs: clarify Context.invoke behavior for required arguments#3297
Closed
wwenrr wants to merge 1 commit intopallets:mainfrom
Closed
docs: clarify Context.invoke behavior for required arguments#3297wwenrr wants to merge 1 commit intopallets:mainfrom
wwenrr wants to merge 1 commit intopallets:mainfrom
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
Clarify docs for
Context.invoke/Context.forwardto explain behavior from #2801:ctx.invoke(...)can result inNonereaching the callbackWhy
Issue #2801 reports that invoking a command with required arguments from another command can still execute and receive
None.Maintainer feedback indicates this behavior is intended, but the docs for command invocation should make this explicit so users don't misinterpret it as a bug.
Changes
File updated:
docs/advanced.md("Invoking Other Commands" section)Added a concise note describing the parsing/validation difference and a concrete
ctx.invoke(other_cmd)example outcome.Scope
Closes #2801