Skip to content

Commit b991d19

Browse files
ezio-melottiMariatta
authored andcommitted
PEP 581: use auto-numbering for footnotes. (#769)
1 parent b76e1fe commit b991d19

File tree

1 file changed

+34
-34
lines changed

1 file changed

+34
-34
lines changed

pep-0581.rst

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Rationale
2222

2323
CPython's development moved to GitHub on February 2017. All other projects
2424
within the PSF's organization are hosted on GitHub and are using GitHub issues.
25-
CPython is still using Roundup as the issue tracker on bugs.python.org (bpo) [1]_.
25+
CPython is still using Roundup as the issue tracker on bugs.python.org (bpo) [#]_.
2626

2727
Why GitHub
2828
----------
@@ -34,7 +34,7 @@ not currently available on Roundup / bpo.
3434
existing integrations and applications available from GitHub Marketplace to
3535
help with the workflow. New applications are easily installed and enabled.
3636
In addition, we've had great success with building our own GitHub bots, like
37-
miss-islington [14]_, bedevere [15]_, and the-knights-who-say-ni [16]_.
37+
miss-islington [#]_, bedevere [#]_, and the-knights-who-say-ni [#]_.
3838

3939
- Ability to embed/drag and drop screenshots and debug log files into GitHub
4040
pull requests and issues.
@@ -52,19 +52,19 @@ not currently available on Roundup / bpo.
5252

5353
- Support for voting via reactions.
5454

55-
- Support for permalinks [2]_, allowing easy quoting and copying & pasting of
55+
- Support for permalinks [#]_, allowing easy quoting and copying & pasting of
5656
source code.
5757

5858
- Core developers don't have to maintain the issue infrastructure/site, giving
5959
us more time to focus on the development of Python.
6060

61-
- Ability to automatically close issues when a PR has been merged [3]_.
61+
- Ability to automatically close issues when a PR has been merged [#]_.
6262

6363
- Lower barrier to contribution. With more than 28 million users, an open
6464
source contributor is more likely to already have an account and be familiar
6565
with GitHub's interface, making it easier to start contributing.
6666

67-
- Email notifications containing metadata [4]_, integrated with Gmail, allowing
67+
- Email notifications containing metadata [#]_, integrated with Gmail, allowing
6868
systematic filtering of emails.
6969

7070
- Additional privacy, such as offering the user a choice to hide an
@@ -82,7 +82,7 @@ Issues with Roundup / bpo
8282
people who aren't already familiar with the code base.
8383

8484
- The upstream Roundup is in Mercurial. There is an open discussion about
85-
moving the source code of bpo to GitHub [5]_. If the source code of
85+
moving the source code of bpo to GitHub [#]_. If the source code of
8686
bpo does move to GitHub, it will become difficult to update patches from
8787
upstream. But as long as it is in Mercurial, it is difficult to maintain
8888
and onboard new contributors.
@@ -93,13 +93,13 @@ Issues with Roundup / bpo
9393
- Email address is exposed. There is no choice to mask it.
9494

9595
- There is no REST API available. There is an open issue in Roundup for adding
96-
REST API [6]_. Last activity was in 2016.
96+
REST API [#]_. Last activity was in 2016.
9797

9898
- It sends a number of unnecessary emails and notifications, and it is
9999
difficult, if not impossible, to configure. An example is the nosy email,
100100
where email notifications are sent whenever someone adds themselves as "nosy".
101101
An issue has been filed in upstream Roundup about this since 2012 with
102-
little traction [7]_.
102+
little traction [#]_.
103103

104104
- Creating an account has been a hassle. There have been reports of people
105105
having trouble creating accounts or logging in.
@@ -145,7 +145,7 @@ Backup of GitHub data
145145
---------------------
146146

147147
This effort has been started and is being tracked as an issue in core-workflow
148-
[8]_. We're using GitHub's Migrations API [9]_ to download GitHub data for
148+
[#]_. We're using GitHub's Migrations API [#]_ to download GitHub data for
149149
CPython on a daily basis. The archives will be dropped in a S3 bucket.
150150

151151
Thanks to Ernest W. Durbin III for working on this.
@@ -258,19 +258,19 @@ A GitHub account should not be a requirement
258258
--------------------------------------------
259259

260260
Back when moving the CPython codebase from Mercurial to GitHub was being
261-
discussed [10]_ [11]_, it was brought up that we still needed to allow uploading
261+
discussed [#]_ [#]_, it was brought up that we still needed to allow uploading
262262
of patches on bpo, and that a GitHub account should not be a requirement in
263263
order to contribute to Python.
264264

265265
If bpo is made read-only, we'll need to come up with a different solution to
266266
allow people to contribute when they don't have a GitHub account.
267267

268268
One solution is to create a new "python-issues" mailing list, similar to the
269-
[email protected] [12]_ mailing list, to allow people to submit their issues
269+
[email protected] [#]_ mailing list, to allow people to submit their issues
270270
there.
271271

272272
Related to this, since the migration to GitHub in 2017, I recall one case
273-
[13]_ where there was a contributor, who submitted a patch to Mercurial and
273+
[#]_ where there was a contributor, who submitted a patch to Mercurial and
274274
refused to create a GitHub account. Because of this, our bot was unable to
275275
detect whether they had signed the CLA. Another person had volunteered to upload
276276
their patch to GitHub. But it was still required that both people sign the CLA.
@@ -308,56 +308,56 @@ and ideas have been valuable.
308308
References
309309
==========
310310

311-
.. [1] bugs.python.org
311+
.. [#] bugs.python.org
312312
(https://bugs.python.org/)
313313
314-
.. [2] Getting permanent links to files
314+
.. [#] miss-islington
315+
(https://github.com/python/miss-islington)
316+
317+
.. [#] bedevere
318+
(https://github.com/python/bedevere)
319+
320+
.. [#] the-knights-who-say-ni
321+
(https://github.com/python/the-knights-who-say-ni)
322+
323+
.. [#] Getting permanent links to files
315324
(https://help.github.com/articles/getting-permanent-links-to-files/)
316325
317-
.. [3] Closing issues using keywords
326+
.. [#] Closing issues using keywords
318327
(https://help.github.com/articles/closing-issues-using-keywords/)
319328
320-
.. [4] About GitHub email notifications
329+
.. [#] About GitHub email notifications
321330
(https://help.github.com/articles/about-email-notifications/)
322331
323-
.. [5] Consider whether or not to migrate bugs.python.org source code
332+
.. [#] Consider whether or not to migrate bugs.python.org source code
324333
to GitHub repo
325334
(https://github.com/python/bugs.python.org/issues/2)
326335
327-
.. [6] Roundup issue 2550734: Expose roundup via a RESTful interface
336+
.. [#] Roundup issue 2550734: Expose roundup via a RESTful interface
328337
(http://issues.roundup-tracker.org/issue2550734)
329338
330-
.. [7] Roundup issue 2550742: Do not send email by default when adding
339+
.. [#] Roundup issue 2550742: Do not send email by default when adding
331340
or removing oneself from the Nosy list
332341
(http://issues.roundup-tracker.org/issue2550742)
333342
334-
.. [8] Backup GitHub information
343+
.. [#] Backup GitHub information
335344
(https://github.com/python/core-workflow/issues/20)
336345
337-
.. [9] GitHub's Migrations API
346+
.. [#] GitHub's Migrations API
338347
(https://developer.github.com/v3/migrations/orgs/)
339348
340-
.. [10] Python-committers email
349+
.. [#] Python-committers email
341350
(https://mail.python.org/pipermail/python-committers/2015-December/003642.html)
342351
343-
.. [11] Python-committers email
352+
.. [#] Python-committers email
344353
(https://mail.python.org/pipermail/python-committers/2015-December/003645.html)
345354
346-
.. [12] docs mailing list
355+
.. [#] docs mailing list
347356
(https://mail.python.org/mailman/listinfo/docs)
348357
349-
.. [13] CPython GitHub pull request 1505
358+
.. [#] CPython GitHub pull request 1505
350359
(https://github.com/python/cpython/pull/1505)
351360
352-
.. [14] miss-islington
353-
(https://github.com/python/miss-islington)
354-
355-
.. [15] bedevere
356-
(https://github.com/python/bedevere)
357-
358-
.. [16] the-knights-who-say-ni
359-
(https://github.com/python/the-knights-who-say-ni)
360-
361361
362362
Copyright
363363
=========

0 commit comments

Comments
 (0)