doc: clarify xmode docstring with mode descriptions#15157
Open
msanti14 wants to merge 1 commit intoipython:mainfrom
Open
doc: clarify xmode docstring with mode descriptions#15157msanti14 wants to merge 1 commit intoipython:mainfrom
msanti14 wants to merge 1 commit intoipython: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
1 participant
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
Closes #13981
The
%xmodemagic docstring listed valid modes but did not describewhat each mode does. This PR adds a brief description for each mode
and clarifies that calling
%xmodewithout arguments cycles throughmodes rather than just toggling.
Changes
--show/--hidein Verbose modeAI Usage
Copilot was used to draft the docstring. All suggestions were reviewed,
tested, and corrected where inaccurate (specifically the Docs mode description).