Skip to content

Commit fb18748

Browse files
authored
Use double backticks for code in RST, change Github to GitHub (#829)
1 parent 29bfc8d commit fb18748

File tree

4 files changed

+25
-25
lines changed

4 files changed

+25
-25
lines changed

gh-faq.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ GitHub issues for BPO users
22
===========================
33

44
Here are some frequently asked quesions about how to do things in
5-
Github issues that you used to be able to do on `bpo`_.
5+
GitHub issues that you used to be able to do on `bpo`_.
66

77
Before you ask your own question, make sure you read :doc:`tracker`
88
and :doc:`triaging` (specifically including :doc:`gh-labels`) as those
@@ -11,7 +11,7 @@ pages include a lot of introductory material.
1111
How to format my comments nicely?
1212
---------------------------------
1313

14-
There is a wonderful `beginner guide to writing and formatting on Github
14+
There is a wonderful `beginner guide to writing and formatting on GitHub
1515
<https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github>`_.
1616
Highly recommended.
1717

@@ -29,13 +29,13 @@ If you still insist on pasting it in your comment, do it like this::
2929
How to attach files to an issue?
3030
--------------------------------
3131

32-
Drag them into the comment field, wait until the file uploads, and Github
32+
Drag them into the comment field, wait until the file uploads, and GitHub
3333
will automatically put a link to your file in your comment text.
3434

3535
How to link to file paths in the repository when writing comments?
3636
------------------------------------------------------------------
3737

38-
Use Markdown links. If you link to the default Github path, the file
38+
Use Markdown links. If you link to the default GitHub path, the file
3939
will link to the latest current version on the given branch.
4040

4141
You can get a permanent link to a given revision of a given file by
@@ -44,7 +44,7 @@ You can get a permanent link to a given revision of a given file by
4444
How to do advanced searches?
4545
----------------------------
4646

47-
Use the `Github search syntax`_ or the interactive `advanced search`_ form
47+
Use the `GitHub search syntax`_ or the interactive `advanced search`_ form
4848
that generates search queries for you.
4949

5050
Where is the "nosy list"?
@@ -73,23 +73,23 @@ Add a checkbox list like this in the issue description::
7373
- [ ] https://github.com/octo-org/octo-repo/issues/740
7474
- [ ] Add delight to the experience when all tasks are complete :tada:
7575

76-
then those will become sub-tasks on the given issue. Moreover, Github will
76+
then those will become sub-tasks on the given issue. Moreover, GitHub will
7777
automatically mark a task as complete if the other referenced issue is
78-
closed. More details in the `official Github documentation
78+
closed. More details in the `official GitHub documentation
7979
<https://docs.github.com/en/issues/tracking-your-work-with-issues/about-task-lists>`_.
8080

8181
What on Earth is a "mannequin"?
8282
-------------------------------
8383

84-
For issues migrated to Github from `bpo`_ where the authors or commenters
85-
are not core developers, we opted not to link to their Github accounts
86-
directly. Users not in the `python organization on Github
84+
For issues migrated to GitHub from `bpo`_ where the authors or commenters
85+
are not core developers, we opted not to link to their GitHub accounts
86+
directly. Users not in the `python organization on GitHub
8787
<https://github.com/orgs/python/people>`_ might not like comments to
88-
appear under their name from an automated import. Others never linked Github on
88+
appear under their name from an automated import. Others never linked GitHub on
8989
`bpo`_ in the first place so linking their account, if any, would be impossible.
9090

9191
In those cases a "mannequin" account is present to help follow the conversation
92-
that happened in the issue. In case the user did share their Github account
92+
that happened in the issue. In case the user did share their GitHub account
9393
name in their `bpo`_ profile, we use that. Otherwise, their classic `bpo`_
9494
username is used instead.
9595

@@ -106,7 +106,7 @@ Based on historical data we found those not being used very often.
106106
How to find a random issue?
107107
---------------------------
108108

109-
This is not supported by Github.
109+
This is not supported by GitHub.
110110

111111
Where are regression labels?
112112
----------------------------
@@ -116,5 +116,5 @@ particularly useful outside of the change log.
116116

117117

118118
.. _bpo: https://bugs.python.org/
119-
.. _Github search syntax: https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax
119+
.. _GitHub search syntax: https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax
120120
.. _advanced search: https://github.com/search/advanced

gh-labels.rst

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

3-
Github Labels
3+
GitHub Labels
44
=============
55

6-
We're using labels on Github to categorize issues and pull requests.
6+
We're using labels on GitHub to categorize issues and pull requests.
77
Many labels are shared for both use cases, while some are dedicated
88
only to one. Below is a possibly inexhaustive list, but it should get
99
you going. For a full list, see `here <https://github.com/python/cpython/issues/labels>`_.
@@ -18,7 +18,7 @@ type-behavior
1818

1919
type-documentation
2020
Used for issues/PRs that exclusively involve changes to
21-
the documentation. Documentation includes `*.rst` files, docstrings,
21+
the documentation. Documentation includes ``*.rst`` files, docstrings,
2222
and code comments.
2323

2424
type-enhancement

pullrequest.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ Here are the steps needed in order to sign the CLA:
314314
2. When ``cpython-cla-bot`` comments on your pull request that commit
315315
authors are required to sign a Contributor License Agreement, click
316316
on the button in the comment to sign it. It's enough to log in through
317-
Github. The process is automatic.
317+
GitHub. The process is automatic.
318318

319319
3. After signing, the comment by ``cpython-cla-bot`` will update to
320320
indicate that "all commit authors signed the Contributor License

triaging.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Python triage team. Triagers will be responsible to handle not just issues, but
7373
also pull requests, and even managing backports. A Python triager has access to
7474
more repositories than just CPython.
7575

76-
Any existing active contributor to the Python repository on Github can
76+
Any existing active contributor to the Python repository on GitHub can
7777
transition into becoming a Python triager. They can request this to any core
7878
developer, and the core developer can pass the request to the `Python
7979
organization admin
@@ -151,7 +151,7 @@ specific type, please do not set a type.
151151

152152
Stage
153153
'''''
154-
A needed next action to advance the issue. The *stage* on Github issues is
154+
A needed next action to advance the issue. The *stage* on GitHub issues is
155155
determined by presence of a linked PR and whether the issue is still open
156156
or closed. It is the PR that holds code review-related labels.
157157

@@ -230,7 +230,7 @@ Nosy List
230230
'''''''''
231231
A list of people who may be interested in an issue.
232232

233-
This used to be a feature of the old issue tracker. On Github issues the
233+
This used to be a feature of the old issue tracker. On GitHub issues the
234234
same effect is achieved by tagging people in a comment using ``@username``.
235235

236236
It is acceptable to tag someone to if you think the issue should be brought to
@@ -264,16 +264,16 @@ comment. Long story short, if you add this::
264264
- [ ] https://github.com/octo-org/octo-repo/issues/740
265265
- [ ] Add delight to the experience when all tasks are complete :tada:
266266

267-
then those will become sub-tasks on the given issue. Moreover, Github will
267+
then those will become sub-tasks on the given issue. Moreover, GitHub will
268268
automatically mark a task as complete if the other referenced issue is
269269
closed.
270270

271-
More details in the `official Github documentation
271+
More details in the `official GitHub documentation
272272
<https://docs.github.com/en/issues/tracking-your-work-with-issues/about-task-lists>`_.
273273

274274
Superseder
275275
''''''''''
276-
The issue is a duplicate of the listed issue(s). To make Github mark
276+
The issue is a duplicate of the listed issue(s). To make GitHub mark
277277
an issue as duplicate, write "Duplicate of #xxxx" in a comment.
278278

279279
Status
@@ -302,7 +302,7 @@ a link to relevant web pages.
302302
| Comment abbreviation | Description |
303303
+=============================================================+=======================================================+
304304
| ``#<number>``, | Links to the tracker issue or PR ``<number>`` (they |
305-
| ``GH-<number>`` | share the same sequence of integers on Github). |
305+
| ``GH-<number>`` | share the same sequence of integers on GitHub). |
306306
+-------------------------------------------------------------+-------------------------------------------------------+
307307
| ``BPO-<number>`` | Links to the old bug tracker at bugs.python.org. |
308308
+-------------------------------------------------------------+-------------------------------------------------------+

0 commit comments

Comments
 (0)