Skip to content

Commit

Permalink
Use sentence case for titles (#1162)
Browse files Browse the repository at this point in the history
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
  • Loading branch information
3 people committed Sep 14, 2023
1 parent 5d27e91 commit cb39eca
Show file tree
Hide file tree
Showing 47 changed files with 179 additions and 179 deletions.
6 changes: 3 additions & 3 deletions core-developers/become-core-developer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
.. _coredev:

==============================
How to Become a Core Developer
How to become a core developer
==============================

What it Takes
What it takes
=============

When you have consistently contributed patches which meet quality standards
Expand All @@ -22,7 +22,7 @@ an official offer. How core developers come to that agreement are outlined in
:pep:`13`.


Gaining Commit Privileges
Gaining commit privileges
=========================

After a candidate has demonstrated consistent contributions, commit privileges
Expand Down
2 changes: 1 addition & 1 deletion core-developers/committing.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _committing:

Accepting Pull Requests
Accepting pull requests
=======================

.. highlight:: none
Expand Down
4 changes: 2 additions & 2 deletions core-developers/developer-log.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _developer-log:
.. _developers:

Developer Log
Developer log
=============

This page lists the historical members of the Python development team. (The
Expand All @@ -13,7 +13,7 @@ information.)
:file: developers.csv
:encoding: "utf-8"

Procedure for Granting or Dropping Access
Procedure for granting or dropping access
-----------------------------------------

To be granted the ability to manage who is a committer, you must be a
Expand Down
4 changes: 2 additions & 2 deletions core-developers/experts.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _experts:

=============
Experts Index
Experts index
=============

This document has tables that list Python Modules, Tools, Platforms and
Expand Down Expand Up @@ -362,7 +362,7 @@ version control merwok, ezio-melotti
================== ==========================================================


Documentation Translations
Documentation translations
==========================

For a list of translators, see :ref:`this table about translations <translating>`.
2 changes: 1 addition & 1 deletion core-developers/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
===============
Core Developers
Core developers
===============

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion core-developers/motivations.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _motivations:

============================
Motivations and Affiliations
Motivations and affiliations
============================

CPython core developers participate in the core development process for a
Expand Down
6 changes: 3 additions & 3 deletions core-developers/responsibilities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ making design and development decisions in different areas (as documented
in the :ref:`experts` and :ref:`developers`).


Communication Channels and Bug Notifications
Communication channels and bug notifications
============================================

Mailing lists have generally been replaced by the
Expand All @@ -59,7 +59,7 @@ follow the link and click on the :guilabel:`Watch` button to set your notificati

.. _contributor_agreement:

Sign a Contributor Agreement
Sign a contributor agreement
============================

Submitting a `contributor form for Python`_ licenses any code you contribute to
Expand All @@ -77,7 +77,7 @@ username into your details on the issue tracker.
.. _contributor form for Python: https://www.python.org/psf/contrib/


Pull Request merging
Pull request merging
====================

Once you have your commit privileges on GitHub you will be able to accept
Expand Down
8 changes: 4 additions & 4 deletions developer-workflow/c-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ When in doubt, new internal C functions should be defined in
``Include/internal`` using the ``extern`` keyword.

Private names
--------------
-------------

Any API named with a leading underscore is also considered internal.
There is currently only one main use case for using such names rather than
Expand All @@ -74,7 +74,7 @@ the :ref:`unstable-capi`:
* APIs for very specialized uses like JIT compilers.


Internal API Tests
Internal API tests
------------------

C tests for the internal C API live in ``Modules/_testinternalcapi.c``.
Expand Down Expand Up @@ -128,7 +128,7 @@ Please start a public discussion if these guidelines won't work for your API.

By *return value*, we mean the value returned by the *C return statement*.

C API Tests
C API tests
-----------

Tests for the public C API live in the ``_testcapi`` module.
Expand Down Expand Up @@ -411,7 +411,7 @@ Adding a new definition to the Limited API
- Add tests -- see below.


Limited API Tests
Limited API tests
-----------------

Since Limited API is a subset of the C API, there's no need to test the
Expand Down
14 changes: 7 additions & 7 deletions developer-workflow/communication-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.. _communication:

==============================
Following Python's Development
Following Python's development
==============================

Python's development is communicated through a myriad of ways,
Expand All @@ -24,7 +24,7 @@ in return.

.. _mailinglists:

Mailing Lists
Mailing lists
=============

.. note:: Some mailing lists have been supplanted by categories in the
Expand Down Expand Up @@ -95,7 +95,7 @@ It is also the designated venue for the core developer promotion votes
(as the Discourse equivalent of the `python-committers`_ mailing list).

Tutorials for new users
-------------------------
-----------------------

To start a topic or participate in any discussions in the forum, sign up and
create an account using an email address or GitHub account. You can do so by
Expand Down Expand Up @@ -138,7 +138,7 @@ bottom progress bar to expand it.
Notifications
-------------

Following categories (Category notifications)
Following categories (category notifications)
'''''''''''''''''''''''''''''''''''''''''''''

Notifications can be set for individual categories and topics. To change any of these
Expand All @@ -151,7 +151,7 @@ different options: Watching, Tracking, Watching First Post, Normal, and Muted.
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)
Following individual threads (topic notifications)
''''''''''''''''''''''''''''''''''''''''''''''''''

To follow any individual topics or threads, you can adjust your notifications
Expand Down Expand Up @@ -239,15 +239,15 @@ that way. You can find their blogs (and various other developers who use Python)
at https://planetpython.org/.


Setting Expectations for Open Source Participation
Setting expectations for open source participation
==================================================

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

Additional Repositories
Additional repositories
=======================

`Python Core Workflow`_ hosts the codebase for tools such as `blurb`_.
Expand Down
16 changes: 8 additions & 8 deletions developer-workflow/development-cycle.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _development-cycle:
.. _devcycle:

Development Cycle
Development cycle
=================

The responsibilities of a core developer shift based on what kind of branch of
Expand Down Expand Up @@ -207,13 +207,13 @@ 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
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
Organization repository policy
------------------------------

Within the `GitHub Python organization <https://github.com/python/>`_,
Expand Down Expand Up @@ -254,7 +254,7 @@ specifically want to “bless” one implementation (as with e.g.
`pythoncapi-compat <https://github.com/python/pythoncapi-compat>`_).


Organization Owner Policy
Organization owner policy
-------------------------

The GitHub Organization Owner role allows for full management of all aspects of
Expand All @@ -281,7 +281,7 @@ Owner of the Python Organization.

.. _current owners:

Current Owners
Current owners
--------------

+----------------------+--------------------------------+-----------------+
Expand All @@ -307,7 +307,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
Repository administrator role policy
------------------------------------

The Administrator role on the repository allows for managing all aspects
Expand All @@ -328,7 +328,7 @@ who no longer necessitate this level of access will be removed with notice.
Multi-Factor Authentication must be enabled by the user in order to remain an
Administrator of the repository.

Current Administrators
Current administrators
----------------------

+-------------------+----------------------------------------------------------+-----------------+
Expand All @@ -353,7 +353,7 @@ Current Administrators
| Mariatta Wijaya | Maintainer of bedevere, blurb_it and miss-islington | Mariatta |
+-------------------+----------------------------------------------------------+-----------------+

Repository Release Manager Role Policy
Repository release manager role policy
--------------------------------------

Release Managers for :ref:`in-development <indevbranch>`, :ref:`maintenance
Expand Down
2 changes: 1 addition & 1 deletion developer-workflow/extension-modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.. _extensions:

==================================
Standard Library Extension Modules
Standard library extension modules
==================================

In this section, we could explain how to write a CPython extension with the C language, but the topic can take a complete book.
Expand Down
2 changes: 1 addition & 1 deletion developer-workflow/grammar.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _grammar:

==========================
Changing CPython's Grammar
Changing CPython's grammar
==========================

Abstract
Expand Down
2 changes: 1 addition & 1 deletion developer-workflow/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
====================
Development Workflow
Development workflow
====================

.. toctree::
Expand Down
6 changes: 3 additions & 3 deletions developer-workflow/lang-changes.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
.. _lang-changes:
.. _langchanges:

Changing the Python Language
Changing the Python language
============================
On occasion people come up with an idea on how to change or improve Python as a
programming language. This document is meant to explain exactly what changes
have a reasonable chance of being considered and what the process is to propose
changes to the language.


What Qualifies
What qualifies
--------------
First and foremost, it must be understood that changes to the Python
programming language are difficult to make. When the language changes,
Expand Down Expand Up @@ -66,7 +66,7 @@ see `Justifying Python Language Changes`_.

.. _lang-changes-pep-process:

PEP Process
PEP process
-----------

Once you are certain you have a language change proposal
Expand Down
2 changes: 1 addition & 1 deletion developer-workflow/porting.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _porting:

=========================
Porting to a New Platform
Porting to a new platform
=========================

The first step is to familiarize yourself with the development toolchain on
Expand Down
6 changes: 3 additions & 3 deletions developer-workflow/stdlib.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _stdlib:
.. _stdlibchanges:

Adding to the Stdlib
Adding to the stdlib
====================

While the stdlib contains a great amount of useful code, sometimes you want
Expand Down Expand Up @@ -61,7 +61,7 @@ over other available solutions. All of this means that additions to the stdlib
are not taken lightly.


Acceptable Types of Modules
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
Expand Down Expand Up @@ -120,7 +120,7 @@ also helps to make sure that the overall design of the module continues to be
uniform.


Proposal Process
Proposal process
''''''''''''''''

If the module you want to propose adding to the stdlib meets the requirements,
Expand Down

0 comments on commit cb39eca

Please sign in to comment.