Skip to content

Commit

Permalink
Minor fixes to quickstart doc.
Browse files Browse the repository at this point in the history
This makes the usage far closer to what a user would expect in an interactive
session.
  • Loading branch information
JNRowe committed Jun 11, 2012
1 parent 4602057 commit 8647c55
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ package.

Create an unauthenticated client object::

>>> from github2.client import Github
>>> github = Github()

.. note::
Expand All @@ -28,6 +29,7 @@ Read the description of the ``python-github2`` project::

>>> repo = github.repos.show("ask/python-github2")
>>> repo.description
u'github client in python, with issues support.'

We can take advantage of Python's :func:`dir` to explore the package a
little more::
Expand Down

0 comments on commit 8647c55

Please sign in to comment.