Skip to content

Commit 2b3caa1

Browse files
committed
Minor typo and grammar fixes.
1 parent f1f0dff commit 2b3caa1

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

doc/api/client.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ during setup::
3535
>>> github = Github(username="ask", api_token=".......", cache="cache_dir")
3636

3737
API calls are limited by github.com to 1 per second by default. To have the
38-
Github client enforce this and avoid rate limit errors, pass requests_per_second
39-
in::
38+
``Github`` client enforce this and avoid rate limit errors, pass
39+
``requests_per_second`` in::
4040

4141
>>> from github2.client import Github
4242
>>> github = Github(username="ask", api_token=".......",

doc/contributing.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ contributor.
1111
Following the simple guidelines below makes it easier to review and integrate
1212
your changes:
1313

14-
* `PEP 8`_, the Python style guide, should be followed where possible
14+
* :pep:`8`, the Python style guide, should be followed where possible
1515
* Adding documentation for new methods and classes is very important
1616
* Testing your changes with multiple Python versions is fantastically useful, it
1717
is all too easy to use functionality that exists in only specific Python
@@ -33,8 +33,9 @@ Tests
3333
patches to increase test coverage are greatly appreciated
3434

3535
The preferred way to run the package's tests is with :pypi:`nose`.
36-
``nosetests`` provides excellent reporting options and its additional features
37-
make it invaluable, see the nose_ documentation for usage information.
36+
``nosetests``, nose's command-line test runner, provides excellent reporting
37+
options and its additional features make it invaluable, see the nose_
38+
documentation for usage information.
3839

3940
There is a :pypi:`tox` configuration file included in the repository, you can
4041
use it to run the tests against multiple Python versions with a single command.
@@ -79,7 +80,6 @@ unfortunately can't be used.
7980
likely to be comfortable with these already
8081

8182
.. _GitHub: https://github.com/ask/python-github2/
82-
.. _PEP 8: http://www.python.org/dev/peps/pep-0008/
8383
.. _Sphinx: http://sphinx.pocoo.org/
8484
.. _autodoc: http://sphinx.pocoo.org/ext/autodoc.html#module-sphinx.ext.autodoc
8585
.. _nose: http://somethingaboutorange.com/mrl/projects/nose/

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
:prefix: Download
1818
:class: sidebar
1919

20-
This is an experimental python library implementing all of the features
20+
This is an experimental Python library implementing all of the features
2121
available in version 2 of the `Github API`_.
2222

2323
You should read the developer documentation for the `Github API`_ first.

doc/quickstart.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Quickstart
22
==========
33

44
Once :mod:`github2` is :doc:`installed <install>` we can open an interactive
5-
Python session, and perform some basic tasks to familiarise ourselves with the
5+
Python session and perform some basic tasks to familiarise ourselves with the
66
package.
77

88
Create an unauthenticated client object::

0 commit comments

Comments
 (0)