Skip to content

Commit

Permalink
Lint: Fix subsubsection markups (#1239)
Browse files Browse the repository at this point in the history
Replace ' markup with recommendations from the style guide.
  • Loading branch information
erlend-aasland committed Dec 6, 2023
1 parent 0b52e7b commit 477be7d
Show file tree
Hide file tree
Showing 8 changed files with 47 additions and 45 deletions.
6 changes: 3 additions & 3 deletions core-developers/committing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ clone.
.. _committing-active-branches:

Seeing active branches
''''''''''''''''''''''
^^^^^^^^^^^^^^^^^^^^^^

If you use ``git branch``, then you will see a :ref:`list of branches
<branchstatus>`. The only branch that receives new features is
Expand All @@ -198,7 +198,7 @@ originate on ``main`` and then be ported back to older branches.
.. _branch-merge:

Backporting changes to an older version
'''''''''''''''''''''''''''''''''''''''
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If it is determined that a pull request needs to be backported into one or
more of the maintenance branches, then a core developer can apply the label
Expand Down Expand Up @@ -236,7 +236,7 @@ can apply labels to GitHub pull requests).


Reverting a merged pull request
'''''''''''''''''''''''''''''''
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To revert a merged pull request, press the ``Revert`` button at the
bottom of the pull request. That will bring up the page to create a
Expand Down
6 changes: 3 additions & 3 deletions developer-workflow/communication-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Notifications
-------------

Following categories (category notifications)
'''''''''''''''''''''''''''''''''''''''''''''
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Notifications can be set for individual categories and topics. To change any of these
defaults, you can either go to your user preferences, or visit the category
Expand All @@ -151,7 +151,7 @@ All categories are set by default in Normal mode where you will only be notified
if someone mentions your @name or replies to you.

Following individual threads (topic notifications)
''''''''''''''''''''''''''''''''''''''''''''''''''
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To follow any individual topics or threads, you can adjust your notifications
through the notification button 🔔 found on the right of the topic at the end
Expand All @@ -160,7 +160,7 @@ Select "Watching" and you will be notified when there is any new updated reply
from that particular thread.

Customising notifications on user preference
''''''''''''''''''''''''''''''''''''''''''''
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To get a bird's eye view of all your customised notifications, you can
go to `Preferences of your account <https://discuss.python.org/my/preferences/categories>`_.
Expand Down
36 changes: 18 additions & 18 deletions developer-workflow/development-cycle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ and *null* for final releases), and ``N`` is the release serial number.
Some examples of release tags: ``v3.7.0a1``, ``v3.6.3``, ``v2.7.14rc1``.

Branches
''''''''
--------

There is a branch for each *feature version*, whether released or not (e.g.
3.7, 3.8).
Expand All @@ -43,7 +43,7 @@ There is a branch for each *feature version*, whether released or not (e.g.
.. _indevbranch:

In-development (main) branch
----------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The ``main`` branch is the branch for the next feature release; it is
under active development for all kinds of changes: new features, semantic
Expand All @@ -65,7 +65,7 @@ for release 3.n.
.. _maintbranch:

Maintenance branches
--------------------
^^^^^^^^^^^^^^^^^^^^

A branch for a previous feature release, currently being maintained for bug
fixes, or for the next feature release in its
Expand Down Expand Up @@ -104,7 +104,7 @@ which followed the release of 3.5.1.
.. _secbranch:

Security branches
-----------------
^^^^^^^^^^^^^^^^^

A branch less than 5 years old but no longer in bugfix mode is a security
branch.
Expand All @@ -126,7 +126,7 @@ security patches have been applied to the branch. These releases have a
.. _eolbranch:

End-of-life branches
--------------------
^^^^^^^^^^^^^^^^^^^^

The code base for a release cycle which has reached end-of-life status
is frozen and no longer has a branch in the repo. The final state of
Expand All @@ -141,15 +141,15 @@ The latest release for each Python version can be found on the `download page
.. _stages:

Stages
''''''
------

Based on what stage the :ref:`in-development <indevbranch>` version of Python
is in, the responsibilities of a core developer change in regards to commits
to the :abbr:`VCS (version control system)`.


Pre-alpha
---------
^^^^^^^^^

The branch is in this stage when no official release has been done since
the latest final release. There are no special restrictions placed on
Expand All @@ -159,7 +159,7 @@ breaking the buildbots).
.. _alpha:

Alpha
-----
^^^^^

Alpha releases typically serve as a reminder to core developers that they
need to start getting in changes that change semantics or add something to
Expand All @@ -169,7 +169,7 @@ restrictions are in place while in alpha.
.. _beta:

Beta
----
^^^^

After a first beta release is published, no new features are accepted. Only
bug fixes and improvements to documentation and tests can now be committed.
Expand All @@ -187,7 +187,7 @@ new information about the creation of the 3.5 maintenance branch during beta.
.. _rc:

Release Candidate (RC)
----------------------
^^^^^^^^^^^^^^^^^^^^^^

A branch preparing for an RC release can only have bugfixes applied that have
been reviewed by other core developers. Generally, these issues must be
Expand All @@ -206,21 +206,21 @@ a core developer.
.. _final:

Final
-----
^^^^^

When a final release is being cut, only the release manager (RM) can make
changes to the branch. After the final release is published, the full
:ref:`development cycle <stages>` starts again for the next minor version.


Repository administration
'''''''''''''''''''''''''
-------------------------

The source code is currently hosted on `GitHub
<https://github.com/python/cpython>`_ in the `Python organization <https://github.com/python/>`_.

Organization repository policy
------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Within the `GitHub Python organization <https://github.com/python/>`_,
repositories are expected to relate to the Python language, the CPython
Expand Down Expand Up @@ -261,7 +261,7 @@ specifically want to “bless” one implementation (as with e.g.


Organization owner policy
-------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^

The GitHub Organization Owner role allows for full management of all aspects of
the Python organization. Allowing for visibility and management of all aspects
Expand All @@ -288,7 +288,7 @@ Owner of the Python Organization.
.. _current owners:

Current owners
--------------
^^^^^^^^^^^^^^

+----------------------+--------------------------------+-----------------+
| Name | Role | GitHub Username |
Expand All @@ -314,7 +314,7 @@ mentioned to request assistance from an organization owner.
.. _be performed: https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permissions-for-organization-roles

Repository administrator role policy
------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The Administrator role on the repository allows for managing all aspects
including collaborators, access control, integrations, webhooks, and branch
Expand All @@ -335,7 +335,7 @@ Multi-Factor Authentication must be enabled by the user in order to remain an
Administrator of the repository.

Current administrators
----------------------
^^^^^^^^^^^^^^^^^^^^^^

+-------------------+----------------------------------------------------------+-----------------+
| Name | Role | GitHub Username |
Expand All @@ -360,7 +360,7 @@ Current administrators
+-------------------+----------------------------------------------------------+-----------------+

Repository release manager role policy
--------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Release Managers for :ref:`in-development <indevbranch>`, :ref:`maintenance
<maintbranch>`, and :ref:`security mode <secbranch>` Python releases are
Expand Down
8 changes: 5 additions & 3 deletions developer-workflow/stdlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ are not taken lightly.


Acceptable types of modules
'''''''''''''''''''''''''''
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Typically two types of modules get added to the stdlib. One type is a module
which implements something that is difficult to get right. A good example of
this is the :py:mod:`multiprocessing` package. Working out the various OS
Expand All @@ -83,7 +84,8 @@ it.


Requirements
''''''''''''
^^^^^^^^^^^^

In order for a module to even be considered for inclusion into the stdlib, a
couple of requirements must be met.

Expand Down Expand Up @@ -121,7 +123,7 @@ uniform.


Proposal process
''''''''''''''''
^^^^^^^^^^^^^^^^

If the module you want to propose adding to the stdlib meets the requirements,
you may propose its inclusion
Expand Down
4 changes: 2 additions & 2 deletions documentation/markup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,14 +165,14 @@ Hyperlinks
----------

External links
''''''''''''''
^^^^^^^^^^^^^^

Use ```Link text <http://target>`_`` for inline web links. If the link text
should be the web address, you don't need special markup at all, the parser
finds links and mail addresses in ordinary text.

Internal links
''''''''''''''
^^^^^^^^^^^^^^

Internal linking is done via a special reST role, see the section on specific
markup, :ref:`doc-ref-role`.
Expand Down
4 changes: 2 additions & 2 deletions getting-started/setup-building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ the interpreter you just built.


Clang
'''''
^^^^^

If you are using clang_ to build CPython, some flags you might want to set to
quiet some standard warnings which are specifically superfluous to CPython are
Expand All @@ -246,7 +246,7 @@ still build properly).


Optimization
''''''''''''
^^^^^^^^^^^^

If you are trying to improve CPython's performance, you will probably want
to use an optimized build of CPython. It can take a lot longer to build CPython
Expand Down
22 changes: 11 additions & 11 deletions internals/parser.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,12 +161,12 @@ Grammar expressions
-------------------

``# comment``
'''''''''''''
^^^^^^^^^^^^^

Python-style comments.

``e1 e2``
'''''''''
^^^^^^^^^

Match ``e1``, then match ``e2``.

Expand All @@ -175,7 +175,7 @@ Match ``e1``, then match ``e2``.
rule_name: first_rule second_rule

``e1 | e2``
'''''''''''
^^^^^^^^^^^

Match ``e1`` or ``e2``.

Expand All @@ -190,7 +190,7 @@ first alternative, like so:
| second_alt

``( e )``
'''''''''
^^^^^^^^^

Match ``e``.

Expand All @@ -206,7 +206,7 @@ operator together with the repeat operators:
rule_name: (e1 e2)*

``[ e ] or e?``
'''''''''''''''
^^^^^^^^^^^^^^^

Optionally match ``e``.

Expand All @@ -222,7 +222,7 @@ optional:
rule_name: e (',' e)* [',']

``e*``
''''''
^^^^^^

Match zero or more occurrences of ``e``.

Expand All @@ -231,7 +231,7 @@ Match zero or more occurrences of ``e``.
rule_name: (e1 e2)*

``e+``
''''''
^^^^^^

Match one or more occurrences of ``e``.

Expand All @@ -240,7 +240,7 @@ Match one or more occurrences of ``e``.
rule_name: (e1 e2)+

``s.e+``
''''''''
^^^^^^^^

Match one or more occurrences of ``e``, separated by ``s``. The generated parse
tree does not include the separator. This is otherwise identical to
Expand All @@ -251,14 +251,14 @@ tree does not include the separator. This is otherwise identical to
rule_name: ','.e+

``&e``
''''''
^^^^^^

.. _peg-positive-lookahead:

Succeed if ``e`` can be parsed, without consuming any input.

``!e``
''''''
^^^^^^

.. _peg-negative-lookahead:

Expand All @@ -273,7 +273,7 @@ consists of an atom, which is not followed by a ``.`` or a ``(`` or a
primary: atom !'.' !'(' !'['

``~``
''''''
^^^^^

Commit to the current alternative, even if it fails to parse (this is called
the "cut").
Expand Down
6 changes: 3 additions & 3 deletions testing/coverage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ provided by the stdlib then you can :ref:`use test.regrtest
.. _install_coverage:

Install coverage
''''''''''''''''
^^^^^^^^^^^^^^^^

By default, pip will not install into the in-development version of Python you
just built, and this built version of Python will not see packages installed
Expand Down Expand Up @@ -143,7 +143,7 @@ it. For this, you will again need to use the full path to that installation.
.. _coverage_usage:

Basic usage
'''''''''''
^^^^^^^^^^^

The following command will tell you if your copy of coverage works (substitute
``COVERAGEDIR`` with the directory where your clone exists, e.g.
Expand Down Expand Up @@ -197,7 +197,7 @@ with pages that visibly show what lines of code were or were not executed.
.. _branch_coverage:

Branch coverage
'''''''''''''''
^^^^^^^^^^^^^^^

For the truly daring, you can use another powerful feature of coverage.py:
branch coverage. Testing every possible branch path through code, while a great
Expand Down

0 comments on commit 477be7d

Please sign in to comment.