Bug: Admonition documentation does not clearly support multi-line/formatting use, causing confusion

[reakaleek]

Describe the bug

There is a bug in the documentation regarding admonitions: the current documentation claims admonitions support multiple lines and formatting, but the rendered output does not match this claim. For example, the sample usage in the documentation is misleading, possibly due to missing or extra newlines. This causes confusion for users relying on the documentation to properly format admonitions.

Expected behavior

Admonitions in the documentation should support multiple lines and formatting as stated. The sample example should clearly demonstrate the correct format, including any necessary newlines, so that the rendered output is as expected.

Steps to reproduce

1. Go to the documentation on admonitions.
2. Copy the multiline admonition example as shown.
3. Render or build using docs-builder.
4. Observe that the output may not preserve the expected formatting, especially if there isn't the required extra newline.

Tooling

true,false,false

View original Slack conversation