Skip to content

Fix some bullet lists in the documentation #1602

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
Jul 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions core-team/join-team.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
16 changes: 8 additions & 8 deletions developer-workflow/extension-modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://podman.io/docs/installation>`_
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 <https://podman.io/docs/installation>`_
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 <clinic>`.
Expand Down
19 changes: 11 additions & 8 deletions development-tools/warnings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
12 changes: 7 additions & 5 deletions documentation/translations/coordinating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading