Skip to content

Commit ae39902

Browse files
committed
- Fix several markups
- Fix wrong link
1 parent 218a6b4 commit ae39902

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

pep-0581.rst

+18-16
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@ currently available in Roundup / bpo.
4444
- Core developers don't have to maintain it, giving us more time to focus on
4545
the development of Python.
4646

47-
- We can automatically close issues when a PR has been merged [#close-github-issue].
47+
- We can automatically close issues when a PR has been merged [#close-github-issue]_.
4848

4949
- With more than 28 million users, an open source contributor is more likely
5050
to already have an account, and familiar with GitHub interface, making it
5151
easier to start contributing.
5252

53-
- Email notifications contain metadata [#email-meta], integrated with GMail, and
53+
- Email notifications contain metadata [#email-meta]_, integrated with GMail, and
5454
allows you to systematically filter emails.
5555

5656
- Email address can remain hidden by choice.
@@ -78,10 +78,10 @@ Issues with bpo / Roundup
7878
- Email address is exposed. There is no choice to mask it.
7979

8080
- There is no REST API available. There is an open issue in Roundup for adding
81-
REST API [#roundup-rest-api]. Last activity was in 2016.
81+
REST API [#roundup-rest-api]_. Last activity was in 2016.
8282

8383
- I personally don't want to receive email each time someone added themselves as "nosy"
84-
An issue has been filed in upstream roundup since 2012 with little traction [#nosy-list].
84+
An issue has been filed in upstream roundup since 2012 with little traction [#nosy-list]_.
8585

8686
- Creating an account has been a hassle. We've had reports when people have
8787
trouble creating accounts or logging in.
@@ -129,8 +129,8 @@ Migration Plan
129129
Backup of GitHub data
130130
---------------------
131131

132-
This effort has been started and being tracked as an issue in core-workflow [#backup-github].
133-
We're using GitHub Migrations API [#gh-migrations-api] to download GitHub data
132+
This effort has been started and being tracked as an issue in core-workflow [#backup-github]_.
133+
We're using GitHub Migrations API [#gh-migrations-api]_ to download GitHub data
134134
for CPython on daily basis. The archives will be dropped in an S3 bucket.
135135

136136
Thanks to Ernest W. Durbin III for working on this.
@@ -159,13 +159,15 @@ Type: behavior, crash, compile error, resource usage, security, performance, enh
159159
Components: 2to3, Argument Clinic, asyncio, Build, Cross-build, ctypes, ...
160160
Priority: release blocker, deferred blocker, critical, high, normal, low
161161

162-
We will create the corresponding labels:
162+
We will create the corresponding labels::
163163

164-
type-behavior, type-crash, type-compile error, type-resource usage, ...
165-
components-2to3, components-argument clinic, components-asyncio, ...
166-
priority-release blocker, priority-deferred blocker, priority-critical, ...
164+
type-behavior, type-crash, type-compile error, type-resource usage, ...
167165

168-
In addition, we'll create "needs triage" label.
166+
components-2to3, components-argument clinic, components-asyncio, ...
167+
168+
priority-release blocker, priority-deferred blocker, priority-critical, ...
169+
170+
In addition, we'll create ``needs triage`` label.
169171

170172
Create issue template
171173
---------------------
@@ -182,7 +184,7 @@ The above values are pre-filled in the template. Issue creator will remove texts
182184
that do not apply to their issue.
183185

184186
Based on the above metadata, bedevere-bot can apply the necessary labels to the issue.
185-
If issue creator did not supply the above metadata, the bot will apply "needs triage"
187+
If issue creator did not supply the above metadata, the bot will apply ``needs triage``
186188
label. At that point it will require a core developer to properly label the issue.
187189

188190
Updates to bedevere
@@ -235,13 +237,13 @@ A GitHub account should not be a requirement
235237
--------------------------------------------
236238

237239
Back when it was discussed about moving the CPython codebase from mercurial
238-
to GitHub [#github-cpython-1] and [#github-cpython-2], it was brought up we
240+
to GitHub [#github-cpython-1]_ and [#github-cpython-2]_, it was brought up we
239241
need to still allow uploading patches in bpo.
240242

241243
If bpo is made readonly, we'll need to come up with a different solution.
242244

243245
Related to this, since the migration to GitHub in 2017, I recall one case
244-
[#gh-1501] where we had one contributor who submitted patch to mercurial, and
246+
[#gh-1505]_ where we had one contributor who submitted patch to mercurial, and
245247
refused to create a GitHub account. Because of this, our bot is unable to detect
246248
whether the have signed CLA. Another person had volunteered to upload his
247249
patch to GitHub. But we still require both people to sign the CLA.
@@ -282,10 +284,10 @@ References
282284
.. [#roundup-rest-api] Roundup issue 2550734 Expose roundup via a RESTful interface
283285
(http://issues.roundup-tracker.org/issue2550734)
284286
285-
.. [#gh-1501] CPython GitHub Pull request 1505
287+
.. [#gh-1505] CPython GitHub Pull request 1505
286288
(https://github.com/python/cpython/pull/1505)
287289
288-
.. [#github-cpython1] Python-committers email
290+
.. [#github-cpython-1] Python-committers email
289291
(https://mail.python.org/pipermail/python-committers/2015-December/003642.html)
290292
291293
.. [#github-cpython-2] Python-committers email

0 commit comments

Comments
 (0)