Skip to content

[clang][ReleaseNotes] Fix code block not rendering #135330

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

Merged
merged 1 commit into from
Apr 11, 2025

Conversation

Maetveis
Copy link
Contributor

Bullet lists require a blank line between paragraphs therefore the .. code-block:: directive only renders correctly if preceded by a blank line.

Bullet lists require a blank line between paragraphs therefore the
`.. code-block::` directive only renders correctly if preceded by a
blank line.
@Maetveis
Copy link
Contributor Author

@Maetveis Maetveis requested a review from AaronBallman April 11, 2025 08:50
@Maetveis Maetveis marked this pull request as ready for review April 11, 2025 08:50
@llvmbot llvmbot added the clang Clang issues not falling into any other category label Apr 11, 2025
@llvmbot
Copy link
Member

llvmbot commented Apr 11, 2025

@llvm/pr-subscribers-clang

Author: Mészáros Gergely (Maetveis)

Changes

Bullet lists require a blank line between paragraphs therefore the .. code-block:: directive only renders correctly if preceded by a blank line.


Full diff: https://github.com/llvm/llvm-project/pull/135330.diff

1 Files Affected:

  • (modified) clang/docs/ReleaseNotes.rst (+1)
diff --git a/clang/docs/ReleaseNotes.rst b/clang/docs/ReleaseNotes.rst
index 46d2debec3621..69c7369755c67 100644
--- a/clang/docs/ReleaseNotes.rst
+++ b/clang/docs/ReleaseNotes.rst
@@ -334,6 +334,7 @@ Improvements to Clang's diagnostics
 - Fixed an assertion when referencing an out-of-bounds parameter via a function
   attribute whose argument list refers to parameters by index and the function
   is variadic. e.g.,
+
   .. code-block:: c
 
     __attribute__ ((__format_arg__(2))) void test (int i, ...) { }

@Maetveis Maetveis requested a review from Sirraide April 11, 2025 08:52
Copy link
Member

@Sirraide Sirraide left a comment

Choose a reason for hiding this comment

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

RST...

@Maetveis Maetveis merged commit c58777c into llvm:main Apr 11, 2025
15 checks passed
@Maetveis Maetveis deleted the fix-clang-docs-codeblock branch April 11, 2025 11:53
var-const pushed a commit to ldionne/llvm-project that referenced this pull request Apr 17, 2025
Bullet lists require a blank line between paragraphs therefore the `..
code-block::` directive only renders correctly if preceded by a blank
line.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clang Clang issues not falling into any other category documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants