From 54ffe53429a7b686cdb200fd33f2164622e3da79 Mon Sep 17 00:00:00 2001 From: Yuki Kobayashi Date: Tue, 8 Jul 2025 20:17:39 +0000 Subject: [PATCH] Fix some bullet lists in the documentation Added newlines and fixed indentations so that the lists render correctly. --- core-team/join-team.rst | 9 +++++---- developer-workflow/extension-modules.rst | 16 ++++++++-------- development-tools/warnings.rst | 19 +++++++++++-------- documentation/translations/coordinating.rst | 12 +++++++----- 4 files changed, 31 insertions(+), 25 deletions(-) diff --git a/core-team/join-team.rst b/core-team/join-team.rst index 5735f72a1..1067696bb 100644 --- a/core-team/join-team.rst +++ b/core-team/join-team.rst @@ -89,10 +89,11 @@ Here's what it outputs, you can copy and paste it for your poll: [/poll] The important options in the poll builder set to get this result: - - Show who voted: **disabled** (``public=false``) - - Limit voting to these groups: **committers** (``groups=committers``) - - Automatically close poll: **in 7 days** (``close=...``) - - Show results: **When poll is closed** (``results=on_close``) + +- Show who voted: **disabled** (``public=false``) +- Limit voting to these groups: **committers** (``groups=committers``) +- Automatically close poll: **in 7 days** (``close=...``) +- Show results: **When poll is closed** (``results=on_close``) .. raw:: html diff --git a/developer-workflow/extension-modules.rst b/developer-workflow/extension-modules.rst index d6be88824..7131cfdf8 100644 --- a/developer-workflow/extension-modules.rst +++ b/developer-workflow/extension-modules.rst @@ -555,16 +555,16 @@ Now that the configuration is in place, it remains to compile the project: * ``make regen-configure`` updates the :cpy-file:`configure` script. - The :cpy-file:`configure` script must be generated using a specific version - of ``autoconf``. To that end, the :cpy-file:`Tools/build/regen-configure.sh` - script which the ``regen-configure`` rule is based on either requires Docker - or Podman, the latter being assumed by default. + The :cpy-file:`configure` script must be generated using a specific version + of ``autoconf``. To that end, the :cpy-file:`Tools/build/regen-configure.sh` + script which the ``regen-configure`` rule is based on either requires Docker + or Podman, the latter being assumed by default. - .. tip:: + .. tip:: - We recommend installing `Podman `_ - instead of Docker since the former does not require a background service - and avoids creating files owned by the ``root`` user in some cases. + We recommend installing `Podman `_ + instead of Docker since the former does not require a background service + and avoids creating files owned by the ``root`` user in some cases. * ``make regen-all`` is responsible for regenerating header files and invoking other scripts, such as :ref:`Argument Clinic `. diff --git a/development-tools/warnings.rst b/development-tools/warnings.rst index b6448f397..b30d81131 100644 --- a/development-tools/warnings.rst +++ b/development-tools/warnings.rst @@ -37,15 +37,18 @@ platform-specific warning ignore file. The warning ignore file is either If a warning check fails with: * Unexpected warnings - * Attempt to refactor the code to avoid the warning. - * If it is not possible to avoid the warning document in the PR why it is - reasonable to ignore and add the warning to the platform-specific - warning ignore file. If the file exists in the warning ignore file - increment the count by the number of newly introduced warnings. + + * Attempt to refactor the code to avoid the warning. + * If it is not possible to avoid the warning document in the PR why it is + reasonable to ignore and add the warning to the platform-specific + warning ignore file. If the file exists in the warning ignore file + increment the count by the number of newly introduced warnings. + * Unexpected improvements (less warnings) - * Document in the PR that the change reduces the number of compiler - warnings. Decrement the count in the platform-specific warning - ignore file or remove the file if the count is now zero. + + * Document in the PR that the change reduces the number of compiler + warnings. Decrement the count in the platform-specific warning + ignore file or remove the file if the count is now zero. .. _updating-warning-ignore-file: diff --git a/documentation/translations/coordinating.rst b/documentation/translations/coordinating.rst index 4e78b9247..d2878385e 100644 --- a/documentation/translations/coordinating.rst +++ b/documentation/translations/coordinating.rst @@ -84,11 +84,13 @@ Are there tools to help in managing the repo? Here's what we're using: - :pypi:`poutils` which includes: - - :pypi:`pomerge` to propagate translations from one file to others. - - :pypi:`pospell` to check for typos in ``.po`` files. - - :pypi:`powrap` to rewrap the ``.po`` files - before committing. This helps keep Git diffs short. - - :pypi:`potodo` to list what needs to be translated. + + - :pypi:`pomerge` to propagate translations from one file to others. + - :pypi:`pospell` to check for typos in ``.po`` files. + - :pypi:`powrap` to rewrap the ``.po`` files + before committing. This helps keep Git diffs short. + - :pypi:`potodo` to list what needs to be translated. + - :pypi:`sphinx-lint` to validate reST syntax in translation files. More related tools and projects can be found in the pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy