Skip to content

Commit 5b06427

Browse files
committed
Standardise underlines
1 parent 27e63d7 commit 5b06427

27 files changed

+237
-212
lines changed

committing/experts.rst

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. _experts:
22

3-
Experts Index
4-
=============
3+
===============
4+
Experts Index
5+
===============
56

67
This document has tables that list Python Modules, Tools, Platforms and
78
Interest Areas and GitHub names for each item that indicate a maintainer or
@@ -44,7 +45,8 @@ not feel qualified to make a decision in a particular context.
4445

4546

4647
Stdlib
47-
------
48+
======
49+
4850
==================== =============================================
4951
Module Maintainers
5052
==================== =============================================
@@ -276,7 +278,8 @@ zlib Yhg1s, gpshead*
276278

277279

278280
Tools
279-
-----
281+
=====
282+
280283
================== ===========
281284
Tool Maintainers
282285
================== ===========
@@ -286,7 +289,8 @@ PEG Generator gvanrossum, pablogsal, lysnikolaou
286289

287290

288291
Platforms
289-
---------
292+
=========
293+
290294
=================== ===========
291295
Platform Maintainers
292296
=================== ===========
@@ -305,7 +309,8 @@ JVM/Java frank.wierzbicki^
305309

306310

307311
Miscellaneous
308-
-------------
312+
=============
313+
309314
================== ==========================================================
310315
Interest Area Maintainers
311316
================== ==========================================================
@@ -359,6 +364,6 @@ version control merwok, ezio-melotti
359364

360365

361366
Documentation Translations
362-
--------------------------
367+
==========================
363368

364369
For a list of translators, see :ref:`this table about translations <translating>`.

committing/motivations.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. _motivations:
22

3-
Core Developer Motivations and Affiliations
4-
===========================================
3+
==============================
4+
Motivations and Affiliations
5+
==============================
56

67
CPython core developers participate in the core development process for a
78
variety of reasons. Being accepted as a core developer indicates that
@@ -29,7 +30,7 @@ For more information on the origins and purpose of this page, see
2930
.. _published-motivations:
3031

3132
Published entries
32-
-----------------
33+
=================
3334

3435
The following core developers have chosen to provide additional details
3536
regarding their professional affiliations and (optionally) other reasons for
@@ -270,7 +271,7 @@ participating in the CPython core development process:
270271
.. _goals-of-the-motivations-page:
271272

272273
Goals of this page
273-
------------------
274+
==================
274275

275276
The `issue metrics`_ automatically collected by the CPython issue tracker
276277
strongly suggest that the current core development process is bottlenecked on
@@ -329,7 +330,7 @@ time contributing to CPython development.
329330

330331

331332
Limitations on scope
332-
--------------------
333+
====================
333334

334335
* Specific technical areas of interest for core developers should be captured in
335336
the :ref:`Experts Index <experts>`.

developing/c-api.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
=======================
2-
Changing Python's C API
3-
=======================
1+
=========================
2+
Changing Python's C API
3+
=========================
44

55
The C API is divided into three sections:
66

developing/communication.rst

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
.. _communication:
22

3-
Following Python's Development
4-
==============================
3+
================================
4+
Following Python's Development
5+
================================
56

67
Python's development is communicated through a myriad of ways, mostly through
78
mailing lists, but also other forms.
89

910

1011
Standards of behaviour in these communication channels
11-
------------------------------------------------------
12+
======================================================
1213
We try to foster environments of mutual respect, tolerance and encouragement,
1314
as described in the PSF's `Diversity Statement`_. Abiding by the guidelines
1415
in this document and asking questions or posting suggestions in the
@@ -22,7 +23,7 @@ in return.
2223
.. _mailinglists:
2324

2425
Mailing Lists
25-
-------------
26+
=============
2627

2728
python-dev_ is the primary mailing list for discussions about Python's
2829
development. The list is open to the public and is subscribed to by all core
@@ -93,7 +94,7 @@ RSS feed readers.
9394

9495

9596
Discourse (discuss.python.org web forum)
96-
----------------------------------------
97+
========================================
9798

9899
We have our own `Discourse`_ forum for both developers and users. This forum
99100
complements the `python-dev`_, `python-ideas`_, `python-help`_, and
@@ -111,7 +112,7 @@ It is also a common venue for the core developer promotion votes (this
111112
category is equivalent to the python-committers mailing list).
112113

113114
Tutorials for new users
114-
'''''''''''''''''''''''
115+
-------------------------
115116
To start a topic or participate in any discussions in the forum, sign up and
116117
create an account using an email address or GitHub account. You can do so by
117118
clicking the "Sign Up" button on the top right hand corner of the `Discourse`_
@@ -142,7 +143,7 @@ dots under the message and then on the ⚐ icon. You can also mention the
142143

143144

144145
Reading topics
145-
'''''''''''''''
146+
-----------------
146147
Click a topic title and read down the list of replies in chronological order,
147148
following links or previewing replies and quotes as you go. Use your mouse to
148149
scroll the screen, or use the timeline scroll bar on the right which also shows
@@ -151,10 +152,10 @@ bottom progress bar to expand it.
151152

152153

153154
Notifications
154-
'''''''''''''
155+
-------------
155156

156157
Following categories (Category notifications)
157-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
158+
'''''''''''''''''''''''''''''''''''''''''''''
158159
Notifications can be set for individual categories and topics. To change any of these
159160
defaults, you can either go to your user preferences, or visit the category
160161
page, and use the notification button 🔔 above the topic list,
@@ -166,21 +167,21 @@ All categories are set by default in Normal mode where you will only be notified
166167
if someone mentions your @name or replies to you.
167168

168169
Following individual threads (Topic notifications)
169-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
170+
''''''''''''''''''''''''''''''''''''''''''''''''''
170171
To follow any individual topics or threads, you can adjust your notifications
171172
through the notification button 🔔 found on the right of the topic at the end
172173
of the timeline. You can also do so at the bottom of each topic.
173174
Select "Watching" and you will be notified when there is any new updated reply
174175
from that particular thread.
175176

176177
Customising notifications on user preference
177-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
178+
''''''''''''''''''''''''''''''''''''''''''''
178179
To get a bird's eye view of all your customised notifications, you can
179180
go to `Preferences of your account <https://discuss.python.org/my/preferences/categories>`_.
180181
This allows you to make adjustments according to categories, users, and tags.
181182

182183
Enabling mailing list mode
183-
''''''''''''''''''''''''''
184+
--------------------------
184185
In mailing list mode, you will receive one email per post, as happens with
185186
traditional mailing lists. This is desirable if you prefer to interact via email,
186187
without visiting the forum website.
@@ -195,7 +196,7 @@ mailing list mode" and save changes.
195196

196197

197198
Discord (private chat server)
198-
-----------------------------
199+
=============================
199200

200201
For more real-time discussions, the core development team have a private Discord
201202
server available. Core developers, Steering Council members, triagers, and
@@ -233,7 +234,7 @@ set a specific `Server Nickname`_
233234

234235

235236
IRC
236-
---
237+
===
237238

238239
Some core developers still participate in the ``#python-dev`` IRC channel on
239240
``irc.libera.chat``. This is not a place to ask for help with Python, but to
@@ -242,23 +243,23 @@ discuss issues related to Python's own development. See also the
242243

243244

244245
Blogs
245-
-----
246+
=====
246247

247248
Several core developers are active bloggers and discuss Python's development
248249
that way. You can find their blogs (and various other developers who use Python)
249250
at https://planetpython.org/.
250251

251252

252253
Setting Expectations for Open Source Participation
253-
--------------------------------------------------
254+
==================================================
254255

255256
Burn-out is common in open source due to a misunderstanding of what users, contributors,
256257
and maintainers should expect from each other. Brett Cannon gave a `talk <https://www.youtube.com/watch?v=-Nk-8fSJM6I>`_
257258
about this topic that sets out to help everyone set reasonable expectations of each other in
258259
order to make open source pleasant for everyone involved.
259260

260261
Additional Repositories
261-
-----------------------
262+
=======================
262263

263264
`Python Core Workflow`_ hosts the codebase for tools such as `cherry_picker`_
264265
and `blurb`_.

developing/extensions.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. _extensions:
22

3-
Updating standard library extension modules
4-
===========================================
3+
====================================
4+
Standard Library Extension Modules
5+
====================================
56

67
In this section, we could explain how to write a CPython extension with the C language, but the topic can take a complete book.
78

developing/grammar.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
.. _grammar:
22

3-
Changing CPython's Grammar
4-
==========================
3+
============================
4+
Changing CPython's Grammar
5+
============================
56

67
Abstract
7-
--------
8+
========
89

910
There's more to changing Python's grammar than editing
1011
:file:`Grammar/python.gram`. Here's a checklist.
@@ -20,7 +21,7 @@ For more information on how to use the new parser, check the
2021
:ref:`section on how to use CPython's parser <parser>`.
2122

2223
Checklist
23-
---------
24+
=========
2425

2526
Note: sometimes things mysteriously don't work. Before giving up, try ``make clean``.
2627

developing/porting.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. _porting:
22

3-
Porting Python to a new platform
4-
--------------------------------
3+
===========================
4+
Porting to a New Platform
5+
===========================
56

67
The first step is to familiarize yourself with the development toolchain on
78
the platform in question, notably the C compiler. Make sure you can compile and

documenting/docquality.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
.. _docquality:
22

3-
Helping with Documentation
4-
==========================
3+
============================
4+
Helping with Documentation
5+
============================
56

67
Python is known for having well-written documentation. Maintaining the
78
documentation's accuracy and keeping a high level of quality takes a lot of
@@ -20,7 +21,7 @@ detailed information on how to write documentation and submit changes.
2021

2122

2223
Python Documentation
23-
--------------------
24+
====================
2425

2526
The :ref:`Documenting Python <documenting>` section covers the details of how
2627
Python's documentation works. It includes information about the markup
@@ -43,7 +44,7 @@ mailing list discusses the documentation toolchain, projects, and standards.
4344

4445

4546
Helping with documentation issues
46-
---------------------------------
47+
=================================
4748

4849
If you look at `documentation issues`_ on the `issue tracker`_, you
4950
will find various documentation problems that may need work. Issues vary from
@@ -67,7 +68,7 @@ you will learn the workflow for documentation pull requests.
6768

6869

6970
Proofreading
70-
------------
71+
============
7172

7273
While an issue filed on the `issue tracker`_ means there is a known issue
7374
somewhere, that does not mean there are not other issues lurking about in the

documenting/documenting.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _documenting:
22

3-
==================
4-
Documenting Python
5-
==================
3+
=================
4+
Getting Started
5+
=================
66

77
.. highlight:: rest
88

0 commit comments

Comments
 (0)