Skip to content

Document admonitions in GDScript documentation comments - #12370

Open
Calinou wants to merge 1 commit into
godotengine:masterfrom
Calinou:gdscript-documentation-comments-admonitions
Open

Calinou wants to merge 1 commit into
godotengine:masterfrom
Calinou:gdscript-documentation-comments-admonitions

Conversation

@Calinou

@Calinou Calinou commented Sep 9, 2026

Copy link
Copy Markdown
Member

If we decide not to go forward with the above PR, we should add this to the docs:

.. warning::

    Admonitions do not display on separate paragraphs automatically. You must
    add **two** explicit line breaks with ``[br][br]`` before the admonition to
    ensure it is displayed correctly.

    ::

        ## Example description.
        ## [br][br][note]This is a note.[/note]
        ## [br][br][warning]This is a warning.[/warning]
        @export var example = ""

@Calinou
Calinou requested review from a team as code owners September 9, 2026 23:17
@Calinou Calinou added enhancement topic:gdscript area:manual Issues and PRs related to the Manual/Tutorials section of the documentation waiting on pr merge PRs that can't be merged until an engine PR is merged first labels Sep 9, 2026
@Cykyrios

Copy link
Copy Markdown
Contributor

LGTM. If godotengine/godot#123357 gets merged, the example should be updated to add empty comment lines between each paragraph instead.

@Calinou

Calinou commented Sep 19, 2026

Copy link
Copy Markdown
Member Author

LGTM. If godotengine/godot#123357 gets merged, the example should be updated to add empty comment lines between each paragraph instead.

That PR is now merged, but if godotengine/godot#123353 is also merged, the docs should be valid in their current state already.

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 enhancement topic:gdscript waiting on pr merge PRs that can't be merged until an engine PR is merged first

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants