Added API docs for new methods

nixon · Jun 24, 2011 · 6bba4a8 · 6bba4a8
1 parent c8cd183
commit 6bba4a8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/lib/github_v3_api/org.rb b/lib/github_v3_api/org.rb
@@ -8,6 +8,8 @@ class Org < Entity
       :private_gists, :private_repos, :public_gists, :public_repos, :space,
       :total_private_repos, :type, :url
 
+    # Returns an array of GitHubV3API::Repo instances representing the repos
+    # that belong to this org
     def repos
       api.list_repos(login)
     end

diff --git a/lib/github_v3_api/orgs_api.rb b/lib/github_v3_api/orgs_api.rb
@@ -40,6 +40,10 @@ def get(org_login)
       GitHubV3API::Org.new_with_all_data(self, org_data)
     end
 
+    # Returns an array of GitHubV3API::Repo instances representing the repos
+    # that belong to the specified org.
+    #
+    # +org_login+:: the string ID of the organization, e.g. "github"
     def list_repos(org_login)
       @connection.get("/orgs/#{org_login}/repos").map do |repo_data|
         GitHubV3API::Repo.new(@connection.repos, repo_data)