Skip to content

Commit 1c3d689

Browse files
authored
Fix some bullet lists in the documentation (GH-1602)
Added newlines and fixed indentations so that the lists render correctly.
1 parent 903e4d2 commit 1c3d689

File tree

4 files changed

+31
-25
lines changed

4 files changed

+31
-25
lines changed

core-team/join-team.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,11 @@ Here's what it outputs, you can copy and paste it for your poll:
8989
[/poll]
9090
9191
The important options in the poll builder set to get this result:
92-
- Show who voted: **disabled** (``public=false``)
93-
- Limit voting to these groups: **committers** (``groups=committers``)
94-
- Automatically close poll: **in 7 days** (``close=...``)
95-
- Show results: **When poll is closed** (``results=on_close``)
92+
93+
- Show who voted: **disabled** (``public=false``)
94+
- Limit voting to these groups: **committers** (``groups=committers``)
95+
- Automatically close poll: **in 7 days** (``close=...``)
96+
- Show results: **When poll is closed** (``results=on_close``)
9697

9798
.. raw:: html
9899

developer-workflow/extension-modules.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -555,16 +555,16 @@ Now that the configuration is in place, it remains to compile the project:
555555

556556
* ``make regen-configure`` updates the :cpy-file:`configure` script.
557557

558-
The :cpy-file:`configure` script must be generated using a specific version
559-
of ``autoconf``. To that end, the :cpy-file:`Tools/build/regen-configure.sh`
560-
script which the ``regen-configure`` rule is based on either requires Docker
561-
or Podman, the latter being assumed by default.
558+
The :cpy-file:`configure` script must be generated using a specific version
559+
of ``autoconf``. To that end, the :cpy-file:`Tools/build/regen-configure.sh`
560+
script which the ``regen-configure`` rule is based on either requires Docker
561+
or Podman, the latter being assumed by default.
562562

563-
.. tip::
563+
.. tip::
564564

565-
We recommend installing `Podman <https://podman.io/docs/installation>`_
566-
instead of Docker since the former does not require a background service
567-
and avoids creating files owned by the ``root`` user in some cases.
565+
We recommend installing `Podman <https://podman.io/docs/installation>`_
566+
instead of Docker since the former does not require a background service
567+
and avoids creating files owned by the ``root`` user in some cases.
568568

569569
* ``make regen-all`` is responsible for regenerating header files and
570570
invoking other scripts, such as :ref:`Argument Clinic <clinic>`.

development-tools/warnings.rst

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,18 @@ platform-specific warning ignore file. The warning ignore file is either
3737
If a warning check fails with:
3838

3939
* Unexpected warnings
40-
* Attempt to refactor the code to avoid the warning.
41-
* If it is not possible to avoid the warning document in the PR why it is
42-
reasonable to ignore and add the warning to the platform-specific
43-
warning ignore file. If the file exists in the warning ignore file
44-
increment the count by the number of newly introduced warnings.
40+
41+
* Attempt to refactor the code to avoid the warning.
42+
* If it is not possible to avoid the warning document in the PR why it is
43+
reasonable to ignore and add the warning to the platform-specific
44+
warning ignore file. If the file exists in the warning ignore file
45+
increment the count by the number of newly introduced warnings.
46+
4547
* Unexpected improvements (less warnings)
46-
* Document in the PR that the change reduces the number of compiler
47-
warnings. Decrement the count in the platform-specific warning
48-
ignore file or remove the file if the count is now zero.
48+
49+
* Document in the PR that the change reduces the number of compiler
50+
warnings. Decrement the count in the platform-specific warning
51+
ignore file or remove the file if the count is now zero.
4952

5053
.. _updating-warning-ignore-file:
5154

documentation/translations/coordinating.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,13 @@ Are there tools to help in managing the repo?
8484
Here's what we're using:
8585

8686
- :pypi:`poutils` which includes:
87-
- :pypi:`pomerge` to propagate translations from one file to others.
88-
- :pypi:`pospell` to check for typos in ``.po`` files.
89-
- :pypi:`powrap` to rewrap the ``.po`` files
90-
before committing. This helps keep Git diffs short.
91-
- :pypi:`potodo` to list what needs to be translated.
87+
88+
- :pypi:`pomerge` to propagate translations from one file to others.
89+
- :pypi:`pospell` to check for typos in ``.po`` files.
90+
- :pypi:`powrap` to rewrap the ``.po`` files
91+
before committing. This helps keep Git diffs short.
92+
- :pypi:`potodo` to list what needs to be translated.
93+
9294
- :pypi:`sphinx-lint` to validate reST syntax in translation files.
9395

9496
More related tools and projects can be found in the

0 commit comments

Comments
 (0)