Fix formatting of code in table in bsn! documentation.#24964
Merged
Conversation
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.
bsn! documentation.bsn! documentation.
alice-i-cecile
approved these changes
Jul 12, 2026
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
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.
Objective
Fixes missing content and formatting in the
bsn!macro documentation: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
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