Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jacquev6 committed Mar 19, 2012
1 parent c1440bd commit a0cc821
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 14 deletions.
8 changes: 1 addition & 7 deletions ReferenceOfClasses.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,13 @@
You don't normaly create instances of any class but `Github`.
You obtain instances through calls to `get_` and `create_` methods.

In this documentation:

* `login` is a string containing a user's or organization's login
* `user` is an instance of `AuthenticatedUser` or `NamedUser`
* `name` is a string containing the name of a repository
* `repo` is an instance of `Repository`

Class `Github`
==============
* Constructed from user's login and password
* `get_user()`: `AuthenticatedUser`
* `get_user( login )`: `NamedUser`
* `get_organization( login )`: `Organization`
* `get_gist( id )`: `Gist`

Class `AuthenticatedUser`
=========================
Expand Down
8 changes: 1 addition & 7 deletions github/GenerateDocumentation.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,12 @@ def generateDocumentation():
You don't normaly create instances of any class but `Github`.
You obtain instances through calls to `get_` and `create_` methods.
In this documentation:
* `login` is a string containing a user's or organization's login
* `user` is an instance of `AuthenticatedUser` or `NamedUser`
* `name` is a string containing the name of a repository
* `repo` is an instance of `Repository`
Class `Github`
==============
* Constructed from user's login and password
* `get_user()`: `AuthenticatedUser`
* `get_user( login )`: `NamedUser`
* `get_organization( login )`: `Organization`
* `get_gist( id )`: `Gist`
"""
print generateDocumentation()

0 comments on commit a0cc821

Please sign in to comment.