Permalink
Browse files

Added explanatory comment to UAGHE.h

  • Loading branch information...
1 parent 353de64 commit 965c7845927b5ef8e143838ececc52d287adbac7 Owain R Hunt committed Aug 5, 2010
Showing with 10 additions and 0 deletions.
  1. +9 −0 UAGithubEngine.h
  2. +1 −0 UAGithubEngine.m
View
@@ -27,6 +27,15 @@
- (id)initWithUsername:(NSString *)aUsername apiKey:(NSString *)aKey delegate:(id)theDelegate;
+/*
+ Where methods take a 'whateverPath' argument, supply the full path to 'whatever'.
+ For example, if the method calls for 'repositoryPath', supply @"username/repository".
+
+ Where methods take a 'whateverName' argument, supply just the name of 'whatever'. The username used will be that set in the engine instance.
+
+ For methods that take an NSDictionary as an argument, this should contain the relevant keys and values for the required API call.
+ See the documentation for more details on updating repositories, and adding and editing issues.
+*/
#pragma mark Users
View
@@ -407,6 +407,7 @@ - (NSString *)getBranchesForRepository:(NSString *)repositoryPath
- (NSString *)getIssuesForRepository:(NSString *)repositoryPath withRequestType:(UAGithubRequestType)requestType
{
+ // User UAGithubIssuesOpenRequest for open issues, UAGithubIssuesClosedRequest for closed issues
switch (requestType) {
case UAGithubIssuesOpenRequest:
return [self sendRequest:[NSString stringWithFormat:@"issues/list/%@/open", repositoryPath] requestType:UAGithubIssuesOpenRequest responseType:UAGithubIssuesResponse withParameters:nil];

0 comments on commit 965c784

Please sign in to comment.