8000 Fix some more typos in docs and release notes · sivakanth10/github3.py@2d185dd · GitHub
[go: up one dir, main page]
Skip to content

Commit 2d185dd

Browse files
tedmistontedmiston
committed
Fix some more typos in docs and release notes
1 parent bbbf634 commit 2d185dd

File tree

16 files changed

+25
-25
lines changed

16 files changed

+25
-25
lines changed

‎README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Testing
3434

3535
You can run either ``pip install -r dev-requirements.txt`` to install the
3636
following before testing or simply ``make test-deps``. It is suggested you do
37-
this in a virtual enviroment. These need to be installed for the tests to run.
37+
this in a virtual environment. These need to be installed for the tests to run.
3838

3939
- betamax_
4040
- coverage_ by Ned Batchelder
@@ -75,9 +75,9 @@ Ian Stapleton Cordasco (sigmavirus24)
7575
Contact Options
7676
---------------
7777

78-
- Feel free to use the `github3.py`_ tag on StackOverflow for any questions
78+
- Feel free to use the `github3.py`_ tag on Stack Overflow for any questions
7979
you may have
80-
- If you dislike StackOverflow it is preferred that you send an email to
80+
- If you dislike Stack Overflow it is preferred that you send an email to
8181
github3.py@librelist.com
8282
- You may also contact (via email) the author directly with
8383
questions/suggestions/comments or if you wish to include sensitive data.

‎docs/source/api-reference/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Deprecated Functions
4747

4848
.. warning::
4949

50-
Due to GitHub's anonymous ratelimits, it's strongly advised that you don't
50+
Due to GitHub's anonymous rate limits, it's strongly advised that you don't
5151
use these functions.
5252

5353
.. autofunction:: github3.create_gist

‎docs/source/contributing/testing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ cassette file to the repository, like so:
250250
Recording Cassettes that Require Authentication/Authorization
251251
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
252252

253-
If you need to write a test that requires an Authorization (i.e., oAuth token)
253+
If you need to write a test that requires an Authorization (i.e., OAuth token)
254254
or Authentication (i.e., username and password), all you need to do is set
255255
environment variables when running `py.test`, e.g.,
256256

‎docs/source/examples/gist.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ Creating an anonymous gist
5454
# comment == None
5555
print(gist.html_url)
5656

57-
In the above examples ``'spam.txt'`` is the file name. GitHub will auto-detect
57+
In the above examples ``'spam.txt'`` is the file name. GitHub will autodetect
5858
file type based on extension provided. ``'What... is the air-speed velocity of
5959
an unladen swallow?'`` is the file's content or body. ``'Answer this to cross
60-
the bridge'`` is the gists's description. While required by github3.py, it is
60+
the bridge'`` is the gist's description. While required by github3.py, it is
6161
allowed to be empty, e.g., ``''`` is accepted by GitHub.
6262

6363
Note that anonymous gists are always public.

‎docs/source/examples/issue.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ comment message. Then run the script and watch as the issue opens in your
4040
browser focusing on the comment **you** just created.
4141

4242
The following shows how you could use github3.py to fetch and display your
43-
issues in your own style and in your webbrowser.
43+
issues in your own style and in your web browser.
4444

4545
.. literalinclude:: source/browser.py
4646
:language: python

‎docs/source/examples/iterators.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,6 @@ The Second Approach
6666
6767
------
6868

69-
If there are no new users, these approaches won't impact your ratelimit at
69+
If there are no new users, these approaches won't impact your rate limit at
7070
all. This mimics the ability to conditionally refresh data on almost all other
7171
objects in github3.py.

‎docs/source/examples/octocat.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ What you should see
5959

6060
Thanks Octocat, that means a lot coming from you.
6161
FIN.
62-
Epilog:
62+
Epilogue:
6363
The preceding conversation was entirely fictional. If you didn't realize
6464
that, you need to get out more. And yes, I did just have a
6565
conversation with an API. Cool, no? (Sad too, I guess.)

‎docs/source/examples/source/octocat_say.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
print(github3.octocat("github3.py rocks!"))
77
print("Thanks Octocat, that means a lot coming from you.")
88
print("FIN.")
9-
print("""Epilog:
9+
print("""Epilogue:
1010
The preceding conversation was entirely fictional. If you didn't realize
1111
that, you need to get out more.
1212
""")

‎docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ and feel free to take one.
116116
Running the Unittests
117117
---------------------
118118

119-
The tests are generally run using tox. Tox can be installed lke so
119+
The tests are generally run using tox. Tox can be installed like so
120120

121121
.. code-block:: console
122122

‎docs/source/narrative/getting-started.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ where necessary.
2424
Logging into GitHub using github3.py
2525
------------------------------------
2626

27-
Once you've ipmorted the module, you can get started using the API. It's
27+
Once you've imported the module, you can get started using the API. It's
2828
recommended that you authenticate with GitHub to avoid running into `their
29-
ratelimits`_. To do so you have a few options.
29+
rate limits`_. To do so you have a few options.
3030

3131
First, you can use your username and password. We advise you not to type your
3232
password into your shell or python console directly as others can view that
@@ -76,7 +76,7 @@ GitHub has long supported the use of a second-factor authentication (a.k.a,
7676
2FA) mechanism for logging in. This provides some extra security, especially
7777
around administrative actions on the website. If you choose to login with
7878
simply your username and password and you have to provide github3.py with a
79-
mechanism for obtaining your token and providing it to Github.
79+
mechanism for obtaining your token and providing it to GitHub.
8080

8181
An example mechanism is as follows:
8282

@@ -104,7 +104,7 @@ almost certainly want to obtain an access token.
104104

105105

106106
.. links
107-
.. _their ratelimits:
107+
.. _their rate limits:
108108
https://developer.github.com/v3/#rate-limiting
109109
.. _generate an access token:
110110
https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/

0 commit comments

Comments
 (0)
0