Skip to content

Commit 477be7d

Browse files
Lint: Fix subsubsection markups (#1239)
Replace ' markup with recommendations from the style guide.
1 parent 0b52e7b commit 477be7d

File tree

8 files changed

+47
-45
lines changed

8 files changed

+47
-45
lines changed

Diff for: core-developers/committing.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ clone.
186186
.. _committing-active-branches:
187187

188188
Seeing active branches
189-
''''''''''''''''''''''
189+
^^^^^^^^^^^^^^^^^^^^^^
190190

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

200200
Backporting changes to an older version
201-
'''''''''''''''''''''''''''''''''''''''
201+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
202202

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

237237

238238
Reverting a merged pull request
239-
'''''''''''''''''''''''''''''''
239+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
240240

241241
To revert a merged pull request, press the ``Revert`` button at the
242242
bottom of the pull request. That will bring up the page to create a

Diff for: developer-workflow/communication-channels.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Notifications
138138
-------------
139139

140140
Following categories (category notifications)
141-
'''''''''''''''''''''''''''''''''''''''''''''
141+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
142142

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

153153
Following individual threads (topic notifications)
154-
''''''''''''''''''''''''''''''''''''''''''''''''''
154+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
155155

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

162162
Customising notifications on user preference
163-
''''''''''''''''''''''''''''''''''''''''''''
163+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
164164

165165
To get a bird's eye view of all your customised notifications, you can
166166
go to `Preferences of your account <https://discuss.python.org/my/preferences/categories>`_.

Diff for: developer-workflow/development-cycle.rst

+18-18
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ and *null* for final releases), and ``N`` is the release serial number.
3434
Some examples of release tags: ``v3.7.0a1``, ``v3.6.3``, ``v2.7.14rc1``.
3535

3636
Branches
37-
''''''''
37+
--------
3838

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

4545
In-development (main) branch
46-
----------------------------
46+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4747

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

6767
Maintenance branches
68-
--------------------
68+
^^^^^^^^^^^^^^^^^^^^
6969

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

106106
Security branches
107-
-----------------
107+
^^^^^^^^^^^^^^^^^
108108

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

128128
End-of-life branches
129-
--------------------
129+
^^^^^^^^^^^^^^^^^^^^
130130

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

143143
Stages
144-
''''''
144+
------
145145

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

150150

151151
Pre-alpha
152-
---------
152+
^^^^^^^^^
153153

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

161161
Alpha
162-
-----
162+
^^^^^
163163

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

171171
Beta
172-
----
172+
^^^^
173173

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

189189
Release Candidate (RC)
190-
----------------------
190+
^^^^^^^^^^^^^^^^^^^^^^
191191

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

208208
Final
209-
-----
209+
^^^^^
210210

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

215215

216216
Repository administration
217-
'''''''''''''''''''''''''
217+
-------------------------
218218

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

222222
Organization repository policy
223-
------------------------------
223+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
224224

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

262262

263263
Organization owner policy
264-
-------------------------
264+
^^^^^^^^^^^^^^^^^^^^^^^^^
265265

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

290290
Current owners
291-
--------------
291+
^^^^^^^^^^^^^^
292292

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

316316
Repository administrator role policy
317-
------------------------------------
317+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
318318

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

337337
Current administrators
338-
----------------------
338+
^^^^^^^^^^^^^^^^^^^^^^
339339

340340
+-------------------+----------------------------------------------------------+-----------------+
341341
| Name | Role | GitHub Username |
@@ -360,7 +360,7 @@ Current administrators
360360
+-------------------+----------------------------------------------------------+-----------------+
361361

362362
Repository release manager role policy
363-
--------------------------------------
363+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
364364

365365
Release Managers for :ref:`in-development <indevbranch>`, :ref:`maintenance
366366
<maintbranch>`, and :ref:`security mode <secbranch>` Python releases are

Diff for: developer-workflow/stdlib.rst

+5-3
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ are not taken lightly.
6262

6363

6464
Acceptable types of modules
65-
'''''''''''''''''''''''''''
65+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
66+
6667
Typically two types of modules get added to the stdlib. One type is a module
6768
which implements something that is difficult to get right. A good example of
6869
this is the :py:mod:`multiprocessing` package. Working out the various OS
@@ -83,7 +84,8 @@ it.
8384

8485

8586
Requirements
86-
''''''''''''
87+
^^^^^^^^^^^^
88+
8789
In order for a module to even be considered for inclusion into the stdlib, a
8890
couple of requirements must be met.
8991

@@ -121,7 +123,7 @@ uniform.
121123

122124

123125
Proposal process
124-
''''''''''''''''
126+
^^^^^^^^^^^^^^^^
125127

126128
If the module you want to propose adding to the stdlib meets the requirements,
127129
you may propose its inclusion

Diff for: documentation/markup.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -165,14 +165,14 @@ Hyperlinks
165165
----------
166166

167167
External links
168-
''''''''''''''
168+
^^^^^^^^^^^^^^
169169

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

174174
Internal links
175-
''''''''''''''
175+
^^^^^^^^^^^^^^
176176

177177
Internal linking is done via a special reST role, see the section on specific
178178
markup, :ref:`doc-ref-role`.

Diff for: getting-started/setup-building.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ the interpreter you just built.
227227

228228

229229
Clang
230-
'''''
230+
^^^^^
231231

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

247247

248248
Optimization
249-
''''''''''''
249+
^^^^^^^^^^^^
250250

251251
If you are trying to improve CPython's performance, you will probably want
252252
to use an optimized build of CPython. It can take a lot longer to build CPython

Diff for: internals/parser.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -161,12 +161,12 @@ Grammar expressions
161161
-------------------
162162

163163
``# comment``
164-
'''''''''''''
164+
^^^^^^^^^^^^^
165165

166166
Python-style comments.
167167

168168
``e1 e2``
169-
'''''''''
169+
^^^^^^^^^
170170

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

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

177177
``e1 | e2``
178-
'''''''''''
178+
^^^^^^^^^^^
179179

180180
Match ``e1`` or ``e2``.
181181

@@ -190,7 +190,7 @@ first alternative, like so:
190190
| second_alt
191191

192192
``( e )``
193-
'''''''''
193+
^^^^^^^^^
194194

195195
Match ``e``.
196196

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

208208
``[ e ] or e?``
209-
'''''''''''''''
209+
^^^^^^^^^^^^^^^
210210

211211
Optionally match ``e``.
212212

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

224224
``e*``
225-
''''''
225+
^^^^^^
226226

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

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

233233
``e+``
234-
''''''
234+
^^^^^^
235235

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

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

242242
``s.e+``
243-
''''''''
243+
^^^^^^^^
244244

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

253253
``&e``
254-
''''''
254+
^^^^^^
255255

256256
.. _peg-positive-lookahead:
257257

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

260260
``!e``
261-
''''''
261+
^^^^^^
262262

263263
.. _peg-negative-lookahead:
264264

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

275275
``~``
276-
''''''
276+
^^^^^
277277

278278
Commit to the current alternative, even if it fails to parse (this is called
279279
the "cut").

Diff for: testing/coverage.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ provided by the stdlib then you can :ref:`use test.regrtest
8888
.. _install_coverage:
8989

9090
Install coverage
91-
''''''''''''''''
91+
^^^^^^^^^^^^^^^^
9292

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

145145
Basic usage
146-
'''''''''''
146+
^^^^^^^^^^^
147147

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

199199
Branch coverage
200-
'''''''''''''''
200+
^^^^^^^^^^^^^^^
201201

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

0 commit comments

Comments
 (0)