Skip to content

Commit bac8e98

Browse files
committed
Fix the documentation of that one.
1 parent a73a08b commit bac8e98

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

Classes/GTRepository.h

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -178,13 +178,12 @@ extern NSString *const GTRepositoryCloneOptionsCredentialProvider;
178178
// Lookup an object in the repo using a revparse spec
179179
- (id)lookupObjectByRevspec:(NSString *)spec error:(NSError **)error;
180180

181-
// List all references in the repository
181+
// List all reference names in the repository.
182182
//
183-
// repository - The GTRepository to list references in
184-
// error(out) - will be filled if an error occurs
183+
// error - If not NULL, this pointer will be set to the actual error that occurred.
185184
//
186-
// returns an array of NSStrings holding the names of the references
187-
// returns nil if an error occurred and fills the error parameter
185+
// Returns an array of NSStrings holding the names of the references, nil otherwise
186+
// (and the `error` parameter will be set to the actual error that occurred).
188187
- (NSArray *)referenceNamesWithError:(NSError **)error;
189188

190189
// Enumerate over all references is the repository.

0 commit comments

Comments
 (0)