Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a page on the Output bottom panel #10333

Merged

Conversation

Calinou
Copy link
Member

@Calinou Calinou commented Nov 29, 2024

While print_rich() works independently of RichTextLabel, it still makes use of BBCode. (I'm not sure if there is another location where this paragraph would be more suitable.)

@Calinou Calinou added enhancement area:manual Issues and PRs related to the Manual/Tutorials section of the documentation topic:gui cherrypick:4.3 labels Nov 29, 2024
Copy link
Contributor

@tetrapod00 tetrapod00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The written content looks generally good, but this is the wrong place to put it. Documentation for print_rich() does not belong on a page about RichTextLabel, even if they both happen to use BBCode.

The duplication of BBCode documentation is an ongoing problem, see #9998. Wherever this content ends up, you should probably link to the BBCode reference that already exists in this page. If the BBCode docs are ever consolidated, that link can be redirected to the new BBCode docs.

I am not sure what the best page to put this new content is. If we have a place that already documents print(), it makes sense, but I don't know if we do. Possibly a page in Scripting/Core Features/Debug is the right place (since prints can be used to debug).

@Calinou Calinou force-pushed the bbcode-in-richtextlabel-print-rich branch from 5bb6fce to 480bc61 Compare December 6, 2024 16:59
@Calinou Calinou changed the title Document print_rich() in BBCode in RichTextLabel Add a page on the Output bottom panel Dec 6, 2024
@Calinou
Copy link
Member Author

Calinou commented Dec 6, 2024

This PR now adds a new page on the Output bottom panel, which is linked to on the BBCode in RichTextLabel page.

Copy link
Contributor

@tetrapod00 tetrapod00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me now, thanks for making extensive changes like this!

@tetrapod00 tetrapod00 added the content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features label Dec 6, 2024
@Calinou Calinou force-pushed the bbcode-in-richtextlabel-print-rich branch from 480bc61 to 806a4fc Compare December 7, 2024 07:40
@mhilbrunner mhilbrunner merged commit b7b215d into godotengine:master Dec 8, 2024
1 check passed
@mhilbrunner
Copy link
Member

Thank you!

@Calinou Calinou deleted the bbcode-in-richtextlabel-print-rich branch December 9, 2024 00:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation cherrypick:4.3 content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features enhancement topic:gui
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants