From 97523a1e9c102f1c6ce85da6bdebd54137b7595b Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sun, 27 Sep 2026 09:21:03 +0200 Subject: [PATCH] [TASK] End the sentences that introduce a code block with a colon "Look up the commit ID with", "continue the cherry-pick with" and "you should ideally see something like this" each run into the block below them, so the page shows a sentence that stops. A colon finishes them. The first of those blocks also had its content on the line directly under the directive, without the blank line that separates a directive from its body. render-guides accepts it and the published page shows the block correctly, but it was the only place in this manual written that way. Two paragraphs in the migration how-to deliberately keep no colon: there the sentence resumes after the block ("... by using / make docs / instead of typing a long docker run ... command"). Assisted-by: Claude Opus 5 Signed-off-by: Lina Wolf --- Documentation/Howto/Migration/Index.rst | 2 +- Documentation/Maintainers/BackportChanges.rst | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/Documentation/Howto/Migration/Index.rst b/Documentation/Howto/Migration/Index.rst index 339e238b..bb74f9db 100644 --- a/Documentation/Howto/Migration/Index.rst +++ b/Documentation/Howto/Migration/Index.rst @@ -218,7 +218,7 @@ This allows you to render your documentation by using instead of typing a long :bash:`docker run...` or :bash:`podman run...` command. -When rendering locally you should ideally see something like this +When rendering locally you should ideally see something like this: .. code-block:: text diff --git a/Documentation/Maintainers/BackportChanges.rst b/Documentation/Maintainers/BackportChanges.rst index d1188a7c..7f1e8f29 100644 --- a/Documentation/Maintainers/BackportChanges.rst +++ b/Documentation/Maintainers/BackportChanges.rst @@ -168,9 +168,10 @@ Please make sure that you are in the branch you have just pushed into. Preferably `main`: .. code-block:: shell + git checkout main -Look up the commit ID with +Look up the commit ID with: .. code-block:: shell @@ -206,7 +207,7 @@ For a visual confirmation you can now execute the building process again with: make docs -If everything looks fine continue the cherry-pick with +If everything looks fine continue the cherry-pick with: .. code-block:: shell