Skip to content

Fix formatting of code in table in bsn! documentation.#24964

Merged
alice-i-cecile merged 1 commit into
bevyengine:mainfrom
kpreid:md
Jul 12, 2026
Merged

Fix formatting of code in table in bsn! documentation.#24964
alice-i-cecile merged 1 commit into
bevyengine:mainfrom
kpreid:md

Conversation

@kpreid

@kpreid kpreid commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Objective

Fixes missing content and formatting in the bsn! macro documentation:

Screenshot 2026-07-12 at 10 39 44

Solution

Rustdoc tables https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html#tables are defined as GFM tables https://github.github.com/gfm/#tables-extension- which specifies that

Include a pipe in a cell’s content by escaping it, including inside other inline spans

and so we have to add backslashes even inside a code section.

Also adjusted the alignment of the right edge on some other lines.

Testing

  • Viewed the documentation locally.
image

Rustdoc tables <https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html#tables>
are defined as GFM tables <https://github.github.com/gfm/#tables-extension->
which specifies that

> Include a pipe in a cell’s content by escaping it, including inside other inline spans

and so we have to add backslashes even inside a code section.

Also adjusted the alignment of the right edge on some other lines.
@kpreid kpreid changed the title Fix formatting of code block in table in bsn! documentation. Fix formatting of code in table in bsn! documentation. Jul 12, 2026
@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it A-Scenes Composing and serializing ECS objects labels Jul 12, 2026
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jul 12, 2026
Merged via the queue into bevyengine:main with commit 4527bc0 Jul 12, 2026
47 checks passed
@kpreid kpreid deleted the md branch July 12, 2026 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Scenes Composing and serializing ECS objects C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants