Skip to content

Commit bc27d4e

Browse files
authored
Clarify GTDiff options argument documentation
The diff initializers refer to their options arguments taking "any of the above options", but both GTDiffOptions and GTDiffFindOptions are defined above them and the diff initializers really only accept GTDiffOptions.
1 parent e52feca commit bc27d4e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

ObjectiveGit/GTDiff.h

+8-8
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {
193193
/// newTree - The "right" side of the diff. May be nil to represent an empty
194194
/// tree.
195195
/// repository - The repository to be used for the diff. Cannot be nil.
196-
/// options - A dictionary containing any of the above options key constants, or
196+
/// options - A dictionary containing any of the GTDiffOptions key constants, or
197197
/// nil to use the defaults.
198198
/// error - Populated with an `NSError` object on error, if information is
199199
/// available.
@@ -210,7 +210,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {
210210
/// newIndex - The "right" side of the diff. May be nil to represent an empty
211211
/// index.
212212
/// repository - The repository to be used for the diff. Cannot be nil.
213-
/// options - A dictionary containing any of the above options key constants, or
213+
/// options - A dictionary containing any of the GTDiffOptions key constants, or
214214
/// nil to use the defaults.
215215
/// error - Populated with an `NSError` object on error, if information is
216216
/// available.
@@ -227,7 +227,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {
227227
/// newIndex - The "right" side of the diff. May be nil to represent an empty
228228
/// index.
229229
/// repository - The repository to be used for the diff. Cannot be nil.
230-
/// options - A dictionary containing any of the above options key constants, or
230+
/// options - A dictionary containing any of the GTDiffOptions key constants, or
231231
/// nil to use the defaults.
232232
/// error - Populated with an `NSError` object on error, if information is
233233
/// available.
@@ -247,7 +247,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {
247247
/// repository. The left side of the diff. May be nil to represent an
248248
/// empty tree.
249249
/// repository - The repository to be used for the diff.
250-
/// options - A dictionary containing any of the above options key constants, or
250+
/// options - A dictionary containing any of the GTDiffOptions key constants, or
251251
/// nil to use the defaults.
252252
/// error - Populated with an `NSError` object on error, if information is
253253
/// available.
@@ -260,7 +260,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {
260260
/// This matches the `git diff` command.
261261
///
262262
/// repository - The repository to be used for the diff. May not be nil.
263-
/// options - A dictionary containing any of the above options key constants,
263+
/// options - A dictionary containing any of the GTDiffOptions key constants,
264264
/// or nil to use the defaults.
265265
/// error - Populated with an `NSError` object on error, if information is
266266
/// available.
@@ -273,7 +273,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {
273273
/// tree - The tree to be diffed. The tree will be the left side of the diff.
274274
/// May be nil to represent an empty tree.
275275
/// repository - The repository to be used for the diff. May not be nil.
276-
/// options - A dictionary containing any of the above options key constants, or
276+
/// options - A dictionary containing any of the GTDiffOptions key constants, or
277277
/// nil to use the defaults.
278278
/// error - Populated with an `NSError` object on error, if information is
279279
/// available.
@@ -287,7 +287,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {
287287
/// the working directory as if everything would be part of the initial commit.
288288
///
289289
/// repository - The repository to be used for the diff. May not be nil.
290-
/// options - A dictionary containing any of the above options key constants,
290+
/// options - A dictionary containing any of the GTDiffOptions key constants,
291291
/// or nil to use the defaults.
292292
/// error - Populated if an error occurs.
293293
///
@@ -325,7 +325,7 @@ typedef NS_OPTIONS(NSInteger, GTDiffFindOptionsFlags) {
325325

326326
/// Modify the diff list to combine similar changes using the given options.
327327
///
328-
/// options - A dictionary containing any of the above find options key constants
328+
/// options - A dictionary containing any of the GTDiffFindOptions key constants
329329
/// or nil to use the defaults.
330330
- (void)findSimilarWithOptions:(nullable NSDictionary *)options;
331331

0 commit comments

Comments
 (0)