docs(web): clarify tui plugin logging#32502
Open
hcsum wants to merge 2 commits into
Open
Conversation
github-actions
Bot
added
the
needs:compliance
github-actions
Bot
removed
the
needs:compliance
Contributor
|
Thanks for updating your PR! It now meets our contributing guidelines. 👍 |
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.
Issue for this PR
Related to #31219, can prevent some of it, but not a fix
Type of change
What does this PR do?
This updates the English plugin docs to stop recommending
console.log()in the quickstart example.It replaces that example with
client.app.log()and adds a short note explaining that TUI plugins share the client's terminal session, soconsole.log()andconsole.error()can disrupt the input area.How did you verify your code works?
I verified the change by checking the rendered docs source locally in the repo and confirming the final PR diff only changes the English
plugins.mdxpage.Screenshots / recordings
N/A
Checklist