8000 Merge pull request #874 from tedmiston/fix-docs-typos · sivakanth10/github3.py@1a96157 · GitHub
[go: up one dir, main page]
Skip to content

Commit 1a96157

Browse files
sigmavirus24sigmavirus24
authored
Merge pull request sigmavirus24#874 from tedmiston/fix-docs-typos
Fix docs typos
2 parents 10a12ee + 4a14067 commit 1a96157

File tree

22 files changed

+36
-81
lines changed

22 files changed

+36
-81
lines changed

‎AUTHORS.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,3 +164,5 @@ Contributors
164164
- Hal Wine (@hwine)
165165

166166
- Jacopo Notarstefano (@jacquerie)
167+
168+
- Taylor Edmiston (@tedmiston)

‎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 EDBE

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/api-reference/issues.rst.bk

Lines changed: 0 additions & 47 deletions
This file was deleted.

‎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
""")

0 commit comments

Comments
 (0)
0